Method: projects.locations.clusters.list

Lists all Redis clusters owned by a project in either the specified location (region) or all locations.

The location should have the following format:

  • projects/{projectId}/locations/{locationId}

If locationId is specified as - (wildcard), then all regions available to the project are queried, and the results are aggregated.

HTTP request

GET https://redis.googleapis.com/v1/{parent=projects/*/locations/*}/clusters

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The resource name of the cluster location using the form: projects/{projectId}/locations/{locationId} where locationId refers to a GCP region.

Query parameters

Parameters
pageSize

integer

The maximum number of items to return.

If not specified, a default value of 1000 will be used by the service. Regardless of the pageSize value, the response may include a partial list and a caller should only rely on response's nextPageToken to determine if there are more clusters left to be queried.
pageToken

string

The nextPageToken value returned from a previous [clusters.list][CloudRedis.ListClusters] request, if any.

Request body

The request body must be empty.

Response body

Response for [clusters.list][CloudRedis.ListClusters].

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

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

object (Cluster)

A list of Redis clusters in the project in the specified location, or across all locations.

If the locationId in the parent field of the request is "-", all regions available to the project are queried, and the results aggregated. If in such an aggregated query a location is unavailable, a placeholder Redis entry is included in the response with the name field set to a value of the form projects/{projectId}/locations/{locationId}/clusters/- and the status field set to ERROR and statusMessage field set to "location not available for clusters.list".
nextPageToken

string

Token to retrieve the next page of results, or empty if there are no more results in the list.
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.