Method: projects.locations.clusters.list

Lists Clusters in a given project and location.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The parent location, which owns this collection of clusters.

Authorization requires the following IAM permission on the specified resource parent:

  • edgecontainer.clusters.list

Query parameters

Parameters
pageSize

integer

The maximum number of resources to list.
pageToken

string

A page token received from previous list request. A page token received from previous list request.
filter

string

Only resources matching this filter will be listed.
orderBy

string

Specifies the order in which resources will be listed.

Request body

The request body must be empty.

Response body

List of clusters in a location.

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 location.
nextPageToken

string

A token to retrieve next page of results.
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.