Method: projects.locations.buckets.list

List buckets of a project in a particular location.

HTTP request

GET https://observability.googleapis.com/v1/{parent=projects/*/locations/*}/buckets

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The parent, which owns this collection of buckets. The format is:

projects/[PROJECT_ID]/locations/[LOCATION]

Query parameters

Parameters
pageSize

integer

Optional. The maximum number of buckets to return. If unspecified, then at most 100 buckets are returned. The maximum value is 1000; values above 1000 are coerced to 1000.
pageToken

string

Optional. A page token, received from a previous buckets.list call. Provide this to retrieve the subsequent page.
showDeleted

boolean

Optional. If true, then the response will include deleted buckets.

Request body

The request body must be empty.

Response body

Response for listing buckets.

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

JSON representation 
{
  "buckets": [
    {
      object (Bucket)
    }
  ],
  "nextPageToken": string
}
Fields
buckets[]

object (Bucket)

Optional. The list of buckets.
nextPageToken

string

Optional. A token that can be sent as pageToken to retrieve the next page. When this field is omitted, there are no subsequent pages.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • observability.buckets.list

For more information, see the IAM documentation.