Overview of Search

Oracle Cloud Infrastructure Search lets you find resources in your tenancy without requiring you to navigate through different services and compartments. You do not need to know the compartment or availability domain where a resource exists in order to locate and view its details. Rather, with a free text search or a structured query, you can use as little as a single piece of information, such as the creation date or other supported attribute, to find a resource. Search also helps you avoid the latency associated with loading a long list of results onto a single page or the inconvenience of viewing a long list that spans multiple pages.

You might find it helpful to use Search to find related resources when creating or deleting another resource. For example, you might want to find what compartments already exist before creating a new one because compartments cannot be deleted. Or, if you want to delete a volume, you can use a query to verify that a backup exists.

Another benefit of Search is that you can find resources that require action. For example, you might want to delete terminated block volumes because you no longer need them and don’t want them to count against your service limits. Or, you can search for all resources that match a specific naming scheme, in case you want to act on a category of associated resources. Sometimes, resources in a specific lifecycle state, such as databases in a failed state, require troubleshooting. With Search, you can quickly identify those resources and resolve problems.

Supported Resources

Search supports queries for the following Oracle Cloud Infrastructure services and resources. This table will be updated as query support is added for more resources.

Service Resource Type Attributes
Application Migration amsmigration See Migration Reference
Application Migration amssource See Source Reference.
Analytics Cloud analyticsinstance See AnalyticsInstance Reference.
API Gateway apideployment See Deployment Reference.
API Gateway apigateway See Gateway Reference.
Block Volume bootvolume See BootVolume Reference.
Block Volume bootvolumebackup See BootVolumeBackup Reference.
Block Volume volume See Volume Reference.
Block Volume volumebackup See VolumeBackup Reference.
Block Volume volumebackuppolicy See VolumeBackupPolicy Reference.
Block Volume volumegroup See VolumeGroup Reference.
Block Volume volumegroupbackup See VolumeGroupBackup Reference.
Budgets budget

See Budget Reference.

Compute autoscalingconfiguration

See AutoScalingConfiguration Reference.

Note: Queries for the policies attribute are not supported.

Compute clusternetwork

See ClusterNetwork Reference.

Note: Queries for the primarySubnetId, secondaryVnicSubnets, and timeUpdated attributes are not supported.

Compute consolehistory See ConsoleHistory Reference.
Compute dedicatedvmhost

See DedicatedVmHost Reference.

Compute image See Image Reference.
Compute instance

See Instance Reference.

Note: Queries for the privateIp or publicIp attribute of a vnic will include the related instance, if one exists, and is running, in the query results.

Compute instanceconfiguration See InstanceConfiguration Reference.
Compute instancepool

See InstancePool Reference.

Note: Queries for the primarySubnetId, faultDomains, secondaryVnicSubnets, and loadBalancers attributes are not supported.

Data Catalog datacatalog See Catalog Reference.
Data Flow application See Application Reference.
Data Flow run See Run Reference.
Data Safe datasafeprivateendpoint See DataSafePrivateEndpoint Reference.
Data Science datasciencemodel See Model Reference.
Data Science datasciencenotebooksession See NotebookSession Reference.
Data Science datascienceproject See Project Reference.
Data Science datasciencenotebooksession See NotebookSession Reference.
Data Science datasciencemodel See Model Reference.
Data Transfer datatransferappliance See DataTransferAppliance.
Data Transfer datatransferdevice See DataTransferDevice.
Data Transfer datatransferjob See DataTransferJob.
Data Transfer datatransferpackage See DataTransferPackage.
Database autonomouscontainerdatabase See AutonomousContainerDatabase Reference.
Database autonomousdatabase See AutonomousDatabase Reference.
Database autonomousexadatainfrastructure See AutonomousExadataInfrastructure Reference.
Database backupdestination See BackupDestination Reference.
Database database See Database Reference.
Database dbhome See DbHome Reference.
Database dbsystem See DbSystem Reference.
Database exadatainfrastructure See ExadataInfrastructure Reference.
Database vmcluster See VmCluster Reference.
Database vmclusternetwork See VmClusterNetwork Reference.
Digital Assistant odainstance See OdaInstance Reference.
Email Delivery emailsender See Sender Reference.
Events eventrule See Rule Reference.
File Storage filesystem See FileSystem Reference.
File Storage mounttarget See MountTarget Reference.
Functions functionsapplication See Application Reference.
Functions functionsfunction See Function Reference.
IAM compartment See Compartment Reference.
IAM group See Group Reference.
IAM identityprovider See IdentityProvider Reference.
IAM policy See Policy Reference.
IAM tagdefault See TagDefault Reference.
IAM tagnamespace See TagNamespace Reference.
IAM user See User Reference.

Integration Cloud

integrationinstance See IntegrationInstance Reference.
Monitoring alarm See Search-Supported Attributes for Alarms.
MySQL Database dbsystem See DBSystem Reference.
Networking cpe See Cpe Reference.
Networking crossconnect See CrossConnect Reference.
Networking crossconnectgroup See CrossConnectGroup Reference.
Networking ipsecconnection See IPSecConnection Reference.
Networking ipv6 See IPv6 Reference.
Networking natgateway See NatGateway Reference.
Networking remotepeeringconnection See RemotePeeringConnection Reference.
Networking routetable See RouteTable Reference.
Networking securitylist See SecurityList Reference.
Networking servicegateway See ServiceGateway Reference.
Networking subnet See Subnet Reference.
Networking virtualcircuit See VirtualCircuit Reference.
Networking vcn See Vcn Reference.
Networking vnic

See Vnic Reference.

Note: Queries for the privateIp or publicIp attribute of a vnic will include the related instance, if one exists and is running, in the query results.

Notifications onssubscription

See Subscription Reference.

Note: Queries for the endpoint attribute are not supported.

Notifications onstopic See NotificationTopic Reference.
Object Storage bucket See Bucket Reference.
Oracle NoSQL Database Cloud table See Table Reference.

OS Management

osmsmanagedinstancegroup See ManagedInstanceGroup Reference.

OS Management

osmsscheduledjob See ScheduledJob Reference.

OS Management

osmssoftwaresource See SoftwareSource Reference.
Resource Manager ormjob See Job Reference.
Resource Manager ormstack See Stack Reference.
Service Limits quota See Quota Reference.
Streaming connectharness See ConnectHarness Reference.
Streaming stream See Stream Reference.
Vault key See Key Reference.
Vault vault See Vault Reference.
Vault vaultsecret See Secret Reference.
WAF waascertificate See WaasCertificate Reference.
WAF waaspolicy See WaasPolicy Reference.

Although you can use the query language to search fields and values for any supported attribute, query results only provide information about the following resource attributes:

  • Resource type
  • Oracle Cloud Identifier (OCID)
  • Compartment
  • Availability domain
  • Display name
  • Creation date and time
  • Lifecycle state
  • Tags (visible in the API only)

The preceding attributes are common to most Oracle Cloud Infrastructure resources. Their meaning is consistent across resource types, so they're provided by default for each result when you view a list of query results. Query results do not contain information specific to any resource type except where a matching search term appears. Meaning, you can query for volumes of a certain size. If there's a match, then the search result will display the attribute with the value that matches. In this example, in addition to the common attributes, the result also provides the Size attribute if that's where the match was found. You must view the details of a resource to see other resource-specific information.


If you use the Console, neither query results nor resource details will include either defined tags or free-form tags, due to display constraints. Any given resource might contain hundreds of tags. If you want to see tags, use the API to view resource details.

Required IAM Permissions

The resources that you see in query results depend on the permissions you have in place for the resource type. You do not necessarily see results for everything in the compartment or tenancy. For example, if your user account is not associated with a policy that grants you the ability to, at a minimum, inspect the dbsystem resource type, then you can’t query for DB systems. (The verb inspect lets you list and get resources.) Instead, Search will show no results for queries of DB system resources. For more information about policies, see How Policies Work. For information about the specific permissions required for the list API operation for your desired resource type, see the Policy Reference for the appropriate service.