Method: services.search

Search tenancy units for a managed service.

HTTP request

GET https://serviceconsumermanagement.googleapis.com/v1/{parent=services/*}:search

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Service for which search is performed. services/{service} {service} the name of a service, for example 'service.googleapis.com'.

Authorization requires the following Google IAM permission on the specified resource parent:

  • serviceconsumermanagement.tenancyu.list

Query parameters

Parameters
query

string

Set a query {expression} for querying tenancy units. Your {expression} must be in the format: field_name=literal_string. The field_name is the name of the field you want to compare. Supported fields are tenant_resources.tag and tenant_resources.resource.

For example, to search tenancy units that contain at least one tenant resource with a given tag 'xyz', use the query tenant_resources.tag=xyz. To search tenancy units that contain at least one tenant resource with a given resource name 'projects/123456', use the query tenant_resources.resource=projects/123456.

Multiple expressions can be joined with ANDs. Tenancy units must match all expressions to be included in the result set. For example, tenant_resources.tag=xyz AND tenant_resources.resource=projects/123456

Optional.
pageSize

integer

The maximum number of results returned by this request. Currently, the default maximum is set to 1000. If pageSize isn't provided or the size provided is a number larger than 1000, it's automatically set to 1000.

Optional.
pageToken

string

The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of nextPageToken from the previous response.

Optional.

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

Response for the search query.

JSON representation 
{
  "tenancyUnits": [
    {
      object (TenancyUnit)
    }
  ],
  "nextPageToken": string
}
Fields
tenancyUnits[]

object (TenancyUnit)

Tenancy Units matching the request.
nextPageToken

string

Pagination token for large results.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

Try it!