Overview of Search

Oracle Cloud Infrastructure Search lets you find resources within a tenancy, pages of the Console within services, and documentation within the Oracle Cloud Infrastructure Getting Started Guide and Oracle Cloud Infrastructure User Guide. Search sorts search results by resource, service, or documentation, helping you avoid navigating through menus, 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 can also filter results by criteria specific to the search category after results are found and sorted by category.

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. 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.

Search can also help you find pages within the Console, even if you can't recall their location among services in the navigation menu. When you find a page, if you want to know more about its contents, you can use Search to find documentation to help you. For example, you might search for "create virtual cloud network" if you want to read documentation about creating a virtual cloud network.

Search Categories and Ways to Search Them

To search for a resource, you can use a free text search based on keywords. You can also use structured resource query language to build an advanced query based on as little as a single resource attribute, such as the resource's creation date. Results for resource searches are limited to the tenancy and the currently selected region.

To find a named page in the Console without knowing the service or to locate help in the documentation, you can use a free text search. Advanced queries don't work for these types of searches.

Supported Resources

Search supports queries for the Oracle Cloud Infrastructure services and resources listed in this section. The following table will be updated as query support is added for more resources. You can refer to each resource's object reference for information about the resource, including its attributes. In some cases, where indicated, a resource might not support all attributes for search. Often, services index only the required attributes for a given resource. For current information about supported resources and resource attributes, use the ListResourceTypes API.


Service	Resource Type	Attributes
Classic Migration Service	`amsmigration`	See Migration Reference.
Classic Migration Service	`amssource`	See Source Reference.
Application Performance Monitoring	`apmdomain`	See ApmDomain Reference.
Analytics Cloud	`analyticsinstance`	See AnalyticsInstance Reference.
API Gateway	`apideployment`	See Deployment Reference.
API Gateway	`apigateway`	See Gateway Reference.
API Gateway	`apigatewayapi`	See Api Reference.
API Gateway	`apigatewaycertificate`	See Certificate Reference.
Bastion	`bastion`	See Bastion Reference.
Big Data Service	`bigdataservice`	See BdsInstance Reference.
Block Volume	`bootvolume`	See BootVolume Reference.
Block Volume	`bootvolumebackup`	See BootVolumeBackup Reference.
Block Volume	`bootvolumereplica`	See BootVolumeReplica Reference.
Block Volume	`volume`	See Volume Reference.
Block Volume	`volumebackup`	See VolumeBackup Reference. Note: Queries for the `sourceType` attribute are not supported.
Block Volume	`volumebackuppolicy`	See VolumeBackupPolicy Reference.
Block Volume	`volumegroup`	See VolumeGroup Reference.
Block Volume	`volumegroupbackup`	See VolumeGroupBackup Reference.
Block Volume	`volumereplica`	See VolumeReplica Reference.
Blockchain Platform	`blockchainplatforms`	See BlockchainPlatform Reference.
Budgets	`budget`	See Budget Reference.
Certificates	`cabundle`	See CaBundle Reference.
Certificates	`cabundleassociation`	See Association Reference.
Certificates	`certificate`	See Certificate Reference.
Certificates	`certificateassociation`	See Association Reference.
Certificates	`certificateauthority`	See CertificateAuthority Reference.
Certificates	`certificateauthorityassociation`	See Association Reference.
Cloud Guard	`cloudguarddetectorrecipe`	See DetectorRecipe Reference.
Cloud Guard	`cloudguardmanagedlist`	See ManagedList Reference.
Cloud Guard	`cloudguardresponderrecipe`	See ResponderRecipe Reference.
Cloud Guard	`cloudguardtarget`	See Target 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	`computecapacityreservation`	See ComputeCapacityReservation Reference
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.
Content Management	`oceinstance`	See OceInstance Reference.
Console Dashboards	`dashboards`	See Dashboard Reference
Console Dashboards	`dashboard-groups`	See Dashboard Group Reference
Data Catalog	`datacatalog`	See Catalog Reference.
Data Catalog	`datacatalogprivateendpoint`	See CatalogPrivateEndpoint Reference.
Data Catalog	`datacatalogmetastore`	See Metastore Reference.
Data Flow	`application`	See Application Reference.
Data Flow	`run`	See Run Reference.
Data Integration	`disworkspace`	See Workspace Reference.
Data Labeling	`datalabelingdataset`	See Dataset.
Data Safe	`datasafeprivateendpoint`	See DataSafePrivateEndpoint Reference.
Data Science	`datasciencejob`	See Job Reference.
Data Science	`datasciencejobrun`	See JobRun Reference.
Data Science	`datasciencemodel`	See Model Reference.
Data Science	`datasciencemodeldeployment`	See ModelDeployment Reference.
Data Science	`datasciencenotebooksession`	See NotebookSession Reference.
Data Science	`datascienceproject`	See Project Reference.
Database	`autonomouscontainerdatabase`	See AutonomousContainerDatabase Reference.
Database	`autonomousdatabase`	See AutonomousDatabase Reference.
Database	`autonomousexadatainfrastructure`	See AutonomousExadataInfrastructure Reference.
Database	`autonomousvmcluster`	See AutonomousVmCluster Reference.
Database	`backupdestination`	See BackupDestination Reference.
Database	`cloudexadatainfrastructure`	See CloudExadataInfrastructure Reference.
Database	`cloudvmcluster`	See CloudVmCluster Reference.
Database	`database`	See Database Reference.
Database	`databasesoftwareimage`	See DatabaseSoftwareImage Reference.
Database	`dbhome`	See DbHome Reference.
Database	`dbsystem`	See DbSystem Reference.
Database	`exadatainfrastructure`	See ExadataInfrastructure Reference.
Database	`externalcontainerdatabase`	See ExternalContainerDatabase Reference.
Database	`externaldatabaseconnector`	See ExternalDatabaseConnector Reference.
Database	`externalnoncontainerdatabase`	See ExternalNonContainerDatabase Reference.
Database	`externalpluggabledatabase`	See ExternalPluggableDatabase Reference.
Database	`pluggabledatabase`	See PluggableDatabase Reference.
Database	`vmcluster`	See VmCluster Reference.
Database	`vmclusternetwork`	See VmClusterNetwork Reference.
Database Migration	`agent`	See Agent Reference.
Database Migration	`connection`	See Connection Reference.
Database Migration	`job`	See Job Reference.
Database Migration	`migration`	See Migration Reference.
Database Tools	`databasetoolsconnection`	See Database Tools Connection Reference.
Database Tools	`databasetoolsprivateendpoint`	See Database Tools Private Endpoint Reference
DevOps	`artifact`	See Artifact Reference.
DevOps	`environment`	See Environment Reference.
DevOps	`deployment`	See Deployment Reference.
DevOps	`pipeline`	See Deployment Pipeline Reference.
DevOps	`stage`	See Deployment Stage Reference.
DevOps	`project`	See DevOps Project Reference.
DevOps	`workrequest`	See Work Request 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.
GoldenGate	`deployment`	See Deployment Reference
GoldenGate	`databaseregistration`	See DatabaseRegistration 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	`integrationinstance`	See IntegrationInstance Reference.
Java Management	`fleet`	See FleetSummary Reference.
Load Balancing	`loadbalancer`	See LoadBalancer Reference.
Management Agent	`managementagent`	See ManagementAgent Reference.
Management Agent	`managementagentinstallkey`	See ManagementAgentInstallKey Reference.
Monitoring	`alarm`	See Search-Supported Attributes for Alarms.
Networking	`byoiprange`	See ByoipRange Reference.
Networking	`cpe`	See Cpe Reference.
Networking	`crossconnect`	See CrossConnect Reference.
Networking	`crossconnectgroup`	See CrossConnectGroup Reference.
Networking	`dhcpoptions`	See DhcpOptions Reference.
Networking	`drg`	See Drg Reference.
Networking	`internetgateway`	See InternetGateway Reference.
Networking	`ipsecconnection`	See IPSecConnection Reference.
Networking	`ipv6`	See IPv6 Reference.
Networking	`localpeeringgateway`	See LocalPeeringGateway Reference.
Networking	`natgateway`	See NatGateway Reference.
Networking	`networksecuritygroup`	See NetworkSecurityGroup Reference.
Networking	`publicip`	See PublicIp Reference.
Networking	`publicippool`	See PublicIpPool Reference.
Networking	`privateip`	See PrivateIp 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	`vcn`	See Vcn Reference.
Networking	`virtualcircuit`	See VirtualCircuit Reference.
Networking	`vlan`	See Vlan 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.
NoSQL Database Cloud	`nosqltable`	See Table Reference.
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.
OS Management	`osmsmanagedinstancegroup`	See ManagedInstanceGroup Reference.
OS Management	`osmsscheduledjob`	See ScheduledJob Reference.
OS Management	`osmssoftwaresource`	See SoftwareSource Reference.
Container Registry	`containerimage`	See ContainerImage Reference.
Container Registry	`containerrepository`	See ContainerRepository Reference.
Resource Manager	`ormconfigsourceprovider`	See ConfigurationSourceProvider Reference.
Resource Manager	`ormjob`	See Job Reference.
Resource Manager	`ormstack`	See Stack Reference.
Resource Manager	`ormtemplate`	See Template Reference.
Security Zones	`securityzone`	See SecurityZone
Security Zones	`securityrecipe`	See SecurityRecipe
Service Connector Hub	`serviceconnector`	See ServiceConnector Reference.
Service Limits	`quota`	See Quota Reference.
Service Mesh	`mesh`	See Mesh Reference.
Service Mesh	`meshaccesspolicy`	See Access Policy Reference.
Service Mesh	`meshingressgateway`	See Ingress Gateway Reference.
Service Mesh	`meshingressgatewayroutetable`	See Ingress Gateway Route Table Reference.
Service Mesh	`meshvirtualdeployment`	See Virtual Deployment Reference.
Service Mesh	`meshvirtualservice`	See Virtual Service Reference.
Service Mesh	`meshvirtualserviceroutetable`	See Virtual Service Route Table 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.
Visual Builder	`visualbuilderinstance`	See VbInstance Reference.
VMware solution	`vmwareesxihost`	See EsxiHost Reference.
VMware solution	`vmwaresddc`	See Sddc Reference.
Vulnerability Scanning	`vsshostscanrecipe`	See HostScanRecipe.
Vulnerability Scanning	`vsshostscantarget`	See HostScanTarget.
WAF	`httpredirect`	See HttpRedirect Reference.
WAF	`waasaddresslist`	See AddressList Reference.
WAF	`waascertificate`	See Certificate Reference.
WAF	`waascustomprotectionrule`	See CustomProtectionRule Reference.
WAF	`waaspolicy`	See WaasPolicy Reference.

Common Resource Attributes

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.

Tip

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 search or query results depend on the permissions you have in place for the resource type. You do not necessarily see results for every resource 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.

Permissions and policy language applies to resources. Searching for pages across services in the Console or documentation requires no special permissions because they aren't resources. An administrator cannot restrict access to search results ofr services or documentation.

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.

Oracle Cloud Infrastructure Documentation

Overview of Search

Search Categories and Ways to Search Them

Supported Resources

Common Resource Attributes

Required IAM Permissions