Method: projects.instances.clusters.list

Lists information about clusters in an instance.

HTTP request

GET https://bigtableadmin.googleapis.com/v2/{parent=projects/*/instances/*}/clusters

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

The unique name of the instance for which a list of clusters is requested. Values are of the form projects/<project>/instances/<instance>. Use <instance> = '-' to list Clusters for all Instances in a project, e.g., projects/myproject/instances/-.

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

  • bigtable.clusters.list

Query parameters

Parameters
pageToken

string

DEPRECATED: This field is unused and ignored.

Request body

The request body must be empty.

Response body

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

Response message for BigtableInstanceAdmin.ListClusters.

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

object(Cluster)

The list of requested clusters.

failedLocations[]

string

Locations from which Cluster information could not be retrieved, due to an outage or some other transient condition. Clusters from these locations may be missing from clusters, or may only have partial information returned. Values are of the form projects/<project>/locations/<zone_id>

nextPageToken

string

DEPRECATED: This field is unused and ignored.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/bigtable.admin
  • https://www.googleapis.com/auth/bigtable.admin.cluster
  • https://www.googleapis.com/auth/bigtable.admin.instance
  • https://www.googleapis.com/auth/cloud-bigtable.admin
  • https://www.googleapis.com/auth/cloud-bigtable.admin.cluster
  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-platform.read-only

For more information, see the Authentication Overview.

Was this page helpful? Let us know how we did:

Send feedback about...

Cloud Bigtable Documentation