Method: googleapis.container.v1.projects.locations.clusters.get

Gets the details of a specific cluster.

Arguments

Parameters
name

string

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

clusterId

string

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

projectId

string

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

zone

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.

Raised exceptions

Exceptions
ConnectionError In case of a network problem (such as DNS failure or refused connection).
HttpError If the response status is >= 400 (excluding 429 and 503).
TimeoutError If a long-running operation takes longer to finish than the specified timeout limit.
TypeError If an operation or function receives an argument of the wrong type.
ValueError If an operation or function receives an argument of the right type but an inappropriate value. For example, a negative timeout.

Response

If successful, the response contains an instance of Cluster.

Subworkflow snippet

Some fields might be optional or required. To identify required fields, refer to the API documentation.

YAML

- get:
    call: googleapis.container.v1.projects.locations.clusters.get
    args:
        name: ...
        clusterId: ...
        projectId: ...
        zone: ...
    result: getResult

JSON

[
  {
    "get": {
      "call": "googleapis.container.v1.projects.locations.clusters.get",
      "args": {
        "name": "...",
        "clusterId": "...",
        "projectId": "...",
        "zone": "..."
      },
      "result": "getResult"
    }
  }
]