Searching Resources

The Cloud Asset API allows you to use a custom query language to query resource metadata on a project, folder, or organization.

Before you begin

Calling SearchAllResources

gcloud

You can call SearchAllResources using the gcloud asset search-all-resources command. You must be running Cloud SDK version 302.0.0 or newer. You can check your version with the gcloud version command.

gcloud asset search-all-resources \
  --scope=SCOPE \
  --query=QUERY \
  --asset-types=ASSET_TYPES,… \
  --order-by=ORDER_BY \
  --page-size=PAGE_SIZE \

Where all of the following flags are optional:

  • (Optional) SCOPE: A scope can be a project, a folder, or an organization. The search is limited to the Cloud resources within this scope. The caller must be granted the cloudasset.assets.searchAllResources permission on the desired scope. If not specified, the configured project property will be used. To find the configured project, run: gcloud config get-value project. To change the setting, run: gcloud config set project PROJECT_ID.

    The allowed values are:

    • projects/PROJECT_ID (e.g., "projects/foo-bar")
    • projects/PROJECT_NUMBER (e.g., "projects/12345678")
    • folders/FOLDER_NUMBER (e.g., "folders/1234567")
    • organizations/ORGANIZATION_NUMBER (e.g., "organizations/123456")
  • (Optional) QUERY: The query statement. See how to construct a query for more information. If not specified or empty, it will search all the resources within the specified scope.

    Examples:

    • name:Important to find Cloud resources whose name contains "Important" as a word.
    • displayName:Impor* to find Cloud resources whose display name contains "Impor" as a prefix.
    • description:*por* to find Cloud resources whose description contains "por" as a substring.
    • location:us-west* to find Cloud resources whose location is prefixed with "us-west".
    • labels:prod to find Cloud resources whose labels contain "prod" as a key or value.
    • labels.env:prod to find Cloud resources that have a label "env" and its value is "prod".
    • labels.env:* to find Cloud resources that have a label "env".
    • Important to find Cloud resources that contain "Important" as a word in any of the searchable fields.
    • Impor* to find Cloud resources that contain "Impor" as a prefix in any of the searchable fields.
    • *por* to find Cloud resources that contain "por" as a substring in any of the searchable fields.
    • Important location:(us-west1 OR global) to find Cloud resources that contain "Important" as a word in any of the searchable fields and are also located in the "us-west1" region or the "global" location.
  • (Optional) ASSET_TYPES: A list of asset types to search. If not specified or empty, it will search all the searchable asset types. Example: "cloudresourcemanager.googleapis.com/Project,compute.googleapis.com/Instance" to search project and VM instance resources.

  • (Optional) ORDER_BY: A comma-separated list of fields specifying the sorting order of the results. The default order is ascending. Add " DESC" after the field name to indicate descending order. Redundant space characters are ignored. Example: "location DESC, name". Only string fields in the response are sortable, including name, displayName, description and location.

  • (Optional) PAGE_SIZE: The page size for search result pagination. The maximum is 500. If the value is set to 0, an appropriate default will be selected.

The following are example gcloud commands:

  • Find all resources in "organizations/123456" whose name contains the word mycompany:

    gcloud asset search-all-resources \
      --scope='organizations/123456'
      --query='name:mycompany'
    

api

You can call SearchAllResources using a valid OAuth token for a project. To call the SearchAllResources method from Cloud Shell or any console where the gcloud command is available:

  1. If you haven't configured your project's OAuth consent screen, you'll need to do so. An email address and product name are required for the OAuth consent screen.

    1. Go to the OAuth consent screen for your project.
      Configure consent screen
    2. Enter the Application name you want to display.
    3. Under Support email, select the email address you want to display as a public contact. This must be your email address, or a Google Group you own.
    4. Add any optional details you'd like.
    5. Click Save.
  2. Create an OAuth token for your project. See Setting up OAuth 2.0 for more information.

    1. Go to the Create OAuth client ID page.
      Create OAuth client
    2. Select Desktop app as your Application type.
    3. Click Create.
  3. Download the client_secret.json file.

    1. Go to the Credentials page.
    2. To the right of your new Client ID, click Download JSON.
    3. Securely store the file in a location that only your app can access.
  4. Log in using the JSON file with the following command.

    gcloud auth application-default login --client-id-file=YOUR_JSON_FILE
    

    Note that this command will prompot you to open a link. Make sure the page shows the Application name you set in your OAuth consent screen.

  5. Generate an auth token for your account with the following command:

    TOKEN=$(gcloud auth application-default print-access-token)
    
  6. You can now query resources using curl commands.

    PAGE_SIZE=PAGE_SIZE
    PAGE_TOKEN="PAGE_TOKEN"
    SCOPE="SCOPE"
    QUERY="QUERY"
    ASSET_TYPES="ASSET_TYPES,…"
    ORDER_BY="ORDER_BY"
    curl -s -G \
       -H "Authorization: Bearer $TOKEN" \
       -d "page_size=$PAGE_SIZE" \
       -d "page_token=$PAGE_TOKEN" \
       -d "scope=$SCOPE" \
       -d "asset_types=$ASSET_TYPES" \
       -d "order_by=$ORDER_BY" \
       --data-urlencode "query=$QUERY" \
       "https://cloudasset.googleapis.com/v1/$SCOPE:searchAllResources"
    

Where all of the following flags are optional:

  • SCOPE: is required. A scope can be a project, a folder, or an organization. The search is limited to the Cloud resources within this scope. The caller must be granted the cloudasset.assets.searchAllResources permission on the desired scope.

    The allowed values are:

    • projects/PROJECT_ID (e.g., "projects/foo-bar")
    • projects/PROJECT_NUMBER (e.g., "projects/12345678")
    • folders/FOLDER_NUMBER (e.g., "folders/1234567")
    • organizations/ORGANIZATION_NUMBER (e.g., "organizations/123456")
  • (Optional) QUERY: The query statement. See how to construct a query for more information. If not specified or empty, it will search all the resources within the specified scope.

    Examples:

    • name:Important to find Cloud resources whose name contains "Important" as a word.
    • displayName:Impor* to find Cloud resources whose display name contains "Impor" as a prefix.
    • description:*por* to find Cloud resources whose description contains "por" as a substring.
    • location:us-west* to find Cloud resources whose location is prefixed with "us-west".
    • labels:prod to find Cloud resources whose labels contain "prod" as a key or value.
    • labels.env:prod to find Cloud resources that have a label "env" and its value is "prod".
    • labels.env:* to find Cloud resources that have a label "env".
    • Important to find Cloud resources that contain "Important" as a word in any of the searchable fields.
    • Impor* to find Cloud resources that contain "Impor" as a prefix in any of the searchable fields.
    • *por* to find Cloud resources that contain "por" as a substring in any of the searchable fields.
    • Important location:(us-west1 OR global) to find Cloud resources that contain "Important" as a word in any of the searchable fields and are also located in the "us-west1" region or the "global" location.
  • (Optional) ASSET_TYPES: A list of asset types to search. If not specified or empty, it will search all the searchable asset types. Example: "cloudresourcemanager.googleapis.com/Project,compute.googleapis.com/Instance" to search project and VM instance resources.

  • (Optional) ORDER_BY: A comma-separated list of fields specifying the sorting order of the results. The default order is ascending. Add " DESC" after the field name to indicate descending order. Redundant space characters are ignored. Example: "location DESC, name". Only string fields in the response are sortable, including name, displayName, description and location.

  • (Optional) PAGE_SIZE: The page size for search result pagination. The maximum is 500. If the value is set to 0, an appropriate default will be selected.

  • (Optional) PAGE_TOKEN: The token representing the next batch of results from the preceding call to this method. The page_token must be the same as the value of next_page_token from the preceding call's response.

Client library and API reference

How to construct a query

See query syntax to learn more about the query language.

See searching resources samples to learn more about the sample queries for various real use cases.

Query Cloud resources by resource metadata fields

To search resource metadata, a query expression will be in the following format:

FIELD:QUERY

A searchable resource metadata FIELD can be:

  • name: The full resource name of the resource. Note: Not all the asset types are searchable. See the list of searchable types.
  • displayName: The display name on the UI
  • description: The text description of the resource in one or more paragraphs
  • location: The location of the resource. Location can be "global", regional (e.g. "us-east1"), or zonal (e.g. "us-west1-b").
  • labels: Labels associated with this resource. Labels can match label keys, label values, or both. See Labelling and grouping GCP resources.
  • labels.[key]: Label value identified by the label key associated with this resource. For example: "labels.env:prod". Only hyphens (-), underscores (_), lowercase characters, and numbers are allowed in labels keys. Keys must start with a lowercase character. International characters are allowed. See Labels Requirements.
  • networkTags: Network tags associated with this resource. See Labelling and grouping GCP resources.

Examples: query by specific field

  • Find all resources within your scope whose name contains Important as a word:

    name:Important
    
  • Find all resources within your scope whose displayName starts with prod as a prefix:

    displayName:prod*
    
  • Find all resources within your scope whose description contains a word containing rtant as a substring:

    description:*rtant*
    
  • Find all resources in your scope whose location contains us as a word:

    location:us
    
  • Find all resources in your scope that one of whose labels has key or value contains prod as a word:

    labels:prod
    
  • Find all resources in your scope that one of whose labels has "env" as key and has value containing prod as a word:

    labels.env:prod
    
  • Find all resources in your scope that one of whose labels has "env" as key and has any value:

    labels.env:*
    
  • Find all resources in your scope that one of whose networkTags contains internal as a word:

    networkTags:internal
    
  • Find all resources in your scope whose name contains Important as a word and description contains a word containing rtant as a substring:

    name:Important description:*rtant*
    
  • Find all resources in your scope whose name contains Important as a word or description contains a word containing rtant as a substring:

    name:Important OR description:*rtant*
    

Query Cloud resources by free text

You can also simply use a free text query without specifing a field. Then it will return resources, as long as there is a field in the resource metadata matching the query.

Examples: query by free text

  • Find all resources in your scope whose metadata fields (e.g., name, displayName, description) contain Important as a word:

    Important
    
  • Find all resources in your scope whose metadata fields (e.g., name, displayName, description) contain rtant as a substring:

    *rtant*
    
  • Find all resources in your scope whose metadata fields (e.g., name, displayName, description) contain Important as a word and also contain rtant as a substring:

    Important *rtant*