Required. 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 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
Response message for BigtableInstanceAdmin.ListClusters.
If successful, the response body contains data with the following structure:
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/<zoneId>
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-05-08 UTC."],[[["\u003cp\u003eThis endpoint retrieves a list of clusters within a specified instance using a \u003ccode\u003eGET\u003c/code\u003e request to the provided URL, which follows gRPC Transcoding syntax.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eparent\u003c/code\u003e path parameter is required to specify the instance (or all instances within a project) for which to list clusters, requiring the \u003ccode\u003ebigtable.clusters.list\u003c/code\u003e IAM permission.\u003c/p\u003e\n"],["\u003cp\u003eThe response body includes an array of \u003ccode\u003eclusters\u003c/code\u003e, information about any \u003ccode\u003efailedLocations\u003c/code\u003e where data could not be retrieved, and is intended to provide a comprehensive view of the requested cluster information.\u003c/p\u003e\n"],["\u003cp\u003eThe request body for this request must be empty and is not expected to contain data.\u003c/p\u003e\n"],["\u003cp\u003eThe request requires one of the multiple OAuth scopes listed, covering bigtable admin or cloud platform scopes.\u003c/p\u003e\n"]]],[],null,["# Method: projects.instances.clusters.list\n\nLists information about clusters in an instance.\n\n### HTTP request\n\n`GET https://bigtableadmin.googleapis.com/v2/{parent=projects/*/instances/*}/clusters`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n### Query parameters\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nResponse message for BigtableInstanceAdmin.ListClusters.\n\nIf successful, the response body contains data with the following structure:\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/bigtable.admin`\n- `https://www.googleapis.com/auth/bigtable.admin.cluster`\n- `https://www.googleapis.com/auth/bigtable.admin.instance`\n- `https://www.googleapis.com/auth/cloud-bigtable.admin`\n- `https://www.googleapis.com/auth/cloud-bigtable.admin.cluster`\n- `https://www.googleapis.com/auth/cloud-platform`\n- `https://www.googleapis.com/auth/cloud-platform.read-only`\n\nFor more information, see the [Authentication Overview](/docs/authentication#authorization-gcp)."]]
