Method: projects.locations.clusters.list

Stay organized with collections Save and categorize content based on your preferences.

Lists Clusters in a given project and location.

HTTP request

GET https://alloydb.googleapis.com/v1beta/{parent=projects/*/locations/*}/clusters

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The name of the parent resource. For the required format, see the comment on the Cluster.name field. Additionally, you can perform an aggregated list operation by specifying a value with the following format: * projects/{project}/locations/-

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

  • alloydb.clusters.list

Query parameters

Parameters
pageSize

integer

Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.

pageToken

string

A token identifying a page of results the server should return.

filter

string

Optional. Filtering results

orderBy

string

Optional. Hint for how to order the results

Request body

The request body must be empty.

Response body

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

Message for response to listing Clusters

JSON representation
{
  "clusters": [
    {
      object (Cluster)
    }
  ],
  "nextPageToken": string,
  "unreachable": [
    string
  ]
}
Fields
clusters[]

object (Cluster)

The list of Cluster

nextPageToken

string

A token identifying a page of results the server should return.

unreachable[]

string

Locations that could not be reached.

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.