Method: tagValues.tagHolds.list

Lists TagHolds under a TagValue.

HTTP request

GET https://cloudresourcemanager.googleapis.com/v3/{parent=tagValues/*}/tagHolds

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The resource name of the parent TagValue. Must be of the form: tagValues/{tag-value-id}.

Query parameters

Parameters
pageSize

integer

Optional. The maximum number of TagHolds to return in the response. The server allows a maximum of 300 TagHolds to return. If unspecified, the server will use 100 as the default.

pageToken

string

Optional. A pagination token returned from a previous call to tagHolds.list that indicates where this listing should continue from.

filter

string

Optional. Criteria used to select a subset of TagHolds parented by the TagValue to return. This field follows the syntax defined by aip.dev/160; the holder and origin fields are supported for filtering. Currently only AND syntax is supported. Some example queries are:

  • holder = //compute.googleapis.com/compute/projects/myproject/regions/us-east-1/instanceGroupManagers/instance-group
  • origin = 35678234
  • holder = //compute.googleapis.com/compute/projects/myproject/regions/us-east-1/instanceGroupManagers/instance-group AND origin = 35678234

Request body

The request body must be empty.

Response body

The tagHolds.list response.

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

JSON representation
{
  "tagHolds": [
    {
      object (TagHold)
    }
  ],
  "nextPageToken": string
}
Fields
tagHolds[]

object (TagHold)

A possibly paginated list of TagHolds.

nextPageToken

string

Pagination token.

If the result set is too large to fit in a single response, this token is returned. It encodes the position of the current result cursor. Feeding this value into a new list request with the pageToken parameter gives the next page of the results.

When nextPageToken is not filled in, there is no next page and the list returned is the last page in the result set.

Pagination tokens have a limited lifetime.

Authorization scopes

Requires one of the following OAuth scopes:

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

For more information, see the Authentication Overview.