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 Google API HTTP annotation 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/-.

Query parameters

Parameters
pageToken

string

The value of nextPageToken returned by a previous call.

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.

nextPageToken

string

Set if not all clusters could be returned in a single response. Pass this value to pageToken in another request to get the next page of results.

Authorization

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 Auth Guide.

Monitor your resources on the go

Get the Google Cloud Console app to help you manage your projects.

Send feedback about...

Cloud Bigtable Documentation