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
Message for response to listing Clusters
If successful, the response body contains data with the following structure:
[[["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-07-15 UTC."],[[["\u003cp\u003eThis endpoint allows users to list all clusters within a specified project and location.\u003c/p\u003e\n"],["\u003cp\u003eThe request uses a \u003ccode\u003eGET\u003c/code\u003e method with a specific URL structure, including path parameters for the parent resource.\u003c/p\u003e\n"],["\u003cp\u003eOptional query parameters like \u003ccode\u003epageSize\u003c/code\u003e, \u003ccode\u003epageToken\u003c/code\u003e, \u003ccode\u003efilter\u003c/code\u003e, and \u003ccode\u003eorderBy\u003c/code\u003e can be used to refine the results of the cluster list.\u003c/p\u003e\n"],["\u003cp\u003eThe server responds with a JSON structure containing a list of cluster objects, a token for the next page of results, and a list of unreachable locations.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization requires the \u003ccode\u003ealloydb.clusters.list\u003c/code\u003e IAM permission and the \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e OAuth scope.\u003c/p\u003e\n"]]],[],null,["# Method: projects.locations.clusters.list\n\nLists Clusters in a given project and location.\n\n### HTTP request\n\n`GET https://alloydb.googleapis.com/v1/{parent=projects/*/locations/*}/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\nMessage for response to listing Clusters\n\nIf successful, the response body contains data with the following structure:\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/cloud-platform`\n\nFor more information, see the [Authentication Overview](/docs/authentication#authorization-gcp)."]]
