Searching for resources

Refining your search results

View all resource results

View all catalog results

Use this option to view a filtered catalog search. The first five results are displayed by name. If you want a more detailed search criteria for catalog entries, such as searching the description, you can click this link and get a filtered catalog results view. This option helps you find the offerings that you want to create faster. This appears if it matches to a catalog result. This field doesn't appear if your search query starts with tag:.

Search support cases

Use this option to filter by your open support cases across the platform, including infrastructure resources. This shows up at the end of the search if you search for anything, including if you search by tag:.

Search in IBM Cloud docs

Use this option to get a filtered search of the documentation. This shows up at the end of any search, including if you search by tag:.

Press the Forward Slash key (/) to navigate your cursor to the search field.

Searching with the CLI

You can also search across all your resources by using Lucene query syntax, with a single command by using the IBM Cloud CLI, starting with version 0.6.7.

You can search for the following attributes:

name

The user-defined name of the resource.

region

The geographical location where the resource is created. The allowed values are, for example, us-south, us-east, au-syd, eu-gb, eu-de, and jp-tok.

service_name

The name of the service as it appears in the Name column of the output of ibmcloud catalog service-marketplace.

family

The cloud component to which your resource belongs. The allowed values are: cloud_foundry, containers, container-registry, vmware, resource_controller, is, atracker, ims, iam.

organization_id

The organization GUID.

doc.resource_group_id

The ID of the resource group.

type

The resource type. The allowed values are: k8-cluster, k8-location, namespace, resource-instance, resource-group, vmware-solutions, vpc, volume, vpn, load-balancer, security-group, key, image, subnet, public-gateway, floating-ip, network-acl, flow-log-collector, instance, instance-group, dedicated-host, endpoint-gateway, snapshot, share, backup-policy, vpn-server, virtual-network-interface, placement-group, route, target, cloud-object-storage-infrastructure, block-storage, file-storage, cloud-backup, cdn-powered-by-akamai, direct-link-cloud-exchange, direct-link-cloud-connect, direct-link-colocation, direct-link-network-service-provider, hardware-firewall, hardware-firewall-dedicated, fortigate-security-appliance-1gb, fortigate-security-appliance-10gb, virtual-router-appliance-copy, network-gateway-byoa, network-gateway-juniper-vsrx, ibm-cloud-load-balancer, virtual-server, bare-metal, citrix-virtual-app-desktop, bare-metal-server, serviceid.

creation_date

The date on which the resource is created.

modification_date

The last modification date of the resource.

tags

The tags that have been attached to the resource.

tagReferences.tag.name

The tags that have been attached to a classic infrastructure resource. Requires you to specify -p classic-infrastructure parameter.

_objectType:

The object type of the classic infrastructure resource. Allowed values are: SoftLayer_Virtual_DedicatedHost, SoftLayer_Hardware, SoftLayer_Network_Application_Delivery_Controller, SoftLayer_Network_Subnet_IpAddress, SoftLayer_Network_Vlan, SoftLayer_Network_Vlan_Firewall, SoftLayer_Virtual_Guest. Requires you to specify -p classic-infrastructure parameter.

The usage of -p classic-infrastructure for _objectType SoftLayer_Virtual_DedicatedHost, SoftLayer_Network_Vlan_Firewall, SoftLayer_Virtual_Guest and SoftLayer_Hardware (for the classic infrastructure bare metal servers only) is deprecated since now they are searchable as all other not classic infrastructure resources.

Search by using the API

To search for resources, call The Global Search and Tagging - Search API. The following example searches for all resources with tag "project:myproject" attached.

Use the SearchOptions.Builder to create a SearchOptions object that contains the parameter values for the search method.

Instantiate the SearchOptions struct and set the fields to provide parameter values for the Search method.

curl -X POST -H "Authorization: {iam_token}" -H "Accept: application/json" -H "Content-Type: application/json" -d '{"query": "tags:project\\:myproject OR access_tags:project\\:myproject", "fields": ["*"]}' "api.global-search-tagging.cloud.ibm.com/v3/resources/search"

SearchOptions searchOptions = new SearchOptions.Builder()
  .query("GST-sdk-*")
  .fields(new java.util.ArrayList<String>(java.util.Arrays.asList("*")))
  .searchCursor(searchCursor)
  .build();

Response<ScanResult> response = service.search(searchOptions).execute();
ScanResult scanResult = response.getResult();

System.out.println(scanResult);

const params = {
  query: 'GST-sdk-*',
  fields: ['*'],
  searchCursor: searchCursor,
};

globalSearchService.search(params)
  .then(res => {
    console.log(JSON.stringify(res.result, null, 2));
  })
  .catch(err => {
    console.warn(err)
  });

response = global_search_service.search(query='GST-sdk-*',
                    fields=['*'])
scan_result = response.get_result()

print(json.dumps(scan_result, indent=2))

searchOptions := globalSearchService.NewSearchOptions()
searchOptions.SetLimit(10)
searchOptions.SetQuery("GST-sdk-*")
searchOptions.SetFields([]string{"*"})

scanResult, response, err := globalSearchService.Search(searchOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(scanResult, "", "  ")
fmt.Println(string(b))