Method: projects.locations.clusters.list

Lists Clusters in a given project and location.

HTTP request

GET https://hypercomputecluster.googleapis.com/v1beta/{parent=projects/*/locations/*}/clusters

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. Parent location of the clusters to list, in the format projects/{project}/locations/{location}.

Query parameters

Parameters
pageSize

integer

Optional. Maximum number of clusters to return. The service may return fewer than this value.
pageToken

string

Optional. A page token received from a previous clusters.list call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to clusters.list must match the call that provided the page token.
filter

string

Optional. Filter to apply to the returned results.
orderBy

string

Optional. How to order the resulting clusters. Must be one of the following strings:

  • name
  • name desc
  • createTime
  • createTime desc

If not specified, clusters will be returned in an arbitrary order.

Request body

The request body must be empty.

Response body

Response message for clusters.list.

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

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

object (Cluster)

Clusters in the specified location.
nextPageToken

string

A token that can be sent as pageToken to retrieve the next page. If this field is absent, there are no subsequent pages.
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.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • hypercomputecluster.clusters.list

For more information, see the IAM documentation.