Method: projects.locations.clusters.get

Gets the details of a specific cluster.

HTTP request

GET https://container.googleapis.com/v1/{name=projects/*/locations/*/clusters/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

The name (project, location, cluster) of the cluster to retrieve. Specified in the format projects/*/locations/*/clusters/*.

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

  • container.clusters.get

Query parameters

Parameters
projectId
(deprecated)

string

Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

zone
(deprecated)

string

Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

clusterId
(deprecated)

string

Deprecated. The name of the cluster to retrieve. This field has been deprecated and replaced by the name field.

Request body

The request body must be empty.

Response body

If successful, the response body contains an instance of Cluster.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.