Oracle Cloud Infrastructure Search FAQ
What is Oracle Cloud Infrastructure Search?
Oracle Cloud Infrastructure Search helps you quickly find Oracle Cloud Infrastructure resources that you have access to without requiring you to manually navigate through multiple compartments or resource lists.
Example searches might include:
- Find a single instance in a compartment from a set of thousands of instances, based on the instance's name
- Find a specific resource based on its unique Oracle Cloud Identifier (OCID)
- Find all resources that have a given tag (for example, all resources tagged with “Production”)
- Find all resources that are in a specific lifecycle state (for example, all resources that are "Running")
Will I be able to search for other data, like resource logs?
Not at this time. This initial release of Search is limited to only Oracle Cloud Infrastructure resource data.
What types of searches can I perform?
Search supports both keyword, free text searches and advanced query language-based searches.
When you use the Search box in the Console, Search performs a keyword search for the string you enter. Results are listed in order of relevance. The more relevant the search result, according to the underlying scoring formula, the higher the search result appears in the list. You can then filter or refine your query using the advanced query interface, if needed. Oracle recommends free text searches as the quickest way to look for resources.
Alternately, you can search using our structured query language in the advanced query interface. The Search service's structured query language provides powerful searching and filtering semantics using "where," "sort by," and other common query constructs. To learn more about using Search's structured query language to find Oracle Cloud Infrastructure resources, refer to Search Language Syntax in the service documentation.
What is the cost of Oracle Cloud Infrastructure Search?
Searching for Oracle Cloud Infrastructure resources is free for all users.
What resources will I see in my search results?
Search results only include resources that are currently indexed for Search and that you have permission to view. You will not see any resources that you do not have access to. For more information about permissions and how they impact Search, refer to Details for Search in the service documentation.
Which services and resources are searchable?
Currently, you can search for the following Oracle Cloud Infrastructure resources:
As Search adds support for more services and resources, you can refer to Overview of Search in the service documentation for an up-to-date list.
- Compute: instances, images, console histories
- Block Volume: block volumes, volume backups
- Database: databases, DB systems
- Networking: VCNs, subnets, route tables, security lists
- Object Storage: buckets
- Identity and Access Management (IAM): users, groups, compartments, identity providers
What attributes can I use in my search queries?
You can search based on any attribute you can see in the Console pages that list your resources. For example, you can search for instances by name, region, availability domain, OCID, shape, or launch date. You can find a subnet by its name, OCID, CIDR block, virtual router MAC address, route table, security list, or DHCP options.
Can I search for resources across tenancies?
No. You can see search results from only one tenancy at a time.
Can I search for resources across compartments?
Yes. By default, search results show any matching resource that you have permissions to view, regardless of compartment.
Can I limit my search to a specific compartment?
Yes, you can limit searches to a specific compartment by using the advanced query interface. Construct a query using the query language syntax. In the query, include a where clause that specifies the OCID of a compartment to limit searches to the resources in that compartment. For example, if you want to look for all resources in a specific compartment, you can use the following query:
- all resources
- CompartmentId = 'ocid1.compartment.oc1..aaaa…'
What other filters can I use in my search?
You can filter search results based on compartment, resource type, or availability domain.
Can I sort my search results?
Sorting options depend on how you search for resources. If you use the default free text search, search results are sorted by order of relevance. You cannot change the sort order for free text search results. If you search using the advanced query interface, results are sorted in descending order of time created. This means that the resource that was created last will be listed first. You can change the sorting by using the sorted by clause in your query. For example:
- volume, user resources
- sorted by timeCreated desc
You can sort by display name, creation date, compartment, or resource type, in either ascending or descending order. Resources that do not have the attribute on which the query is based will be displayed at the bottom of the sorted list of search results.
What happens when there are many search results? Is there a limit to how many results I can get?
When a search produces a large number of search results, the resulting behavior depends on what you used to perform the search.
- Console: If you searched by using the console, the maximum number of results displayed is 1000. If you do not see the search results you expected on the page, refine your search query to limit the number of matching results.
- SDK: If you searched by using the SDK, there is no maximum limit to the number of search results. You can specify the maximum results returned in a single call to the service and keep invoking the search function until the pagination token is null.
- CLI: The CLI has the same behavior as the SDK, with no maximum limit of search results.
Can I use multiple attributes in my search query?
Yes, you can base a search on multiple resource attributes. For example, you can search for resources that contain the name "Valentine" with a creation date of February 14.
Is the Search service integrated with the Audit service?
Yes. API calls to the Search service are recorded by the Audit service so you can monitor usage and compliance.