Method: googleapis.container.v1.projects.zones.clusters.list

Lists all clusters owned by a project in either the specified zone or all zones.

Arguments

Parameters
projectId

string

Deprecated. (Although deprecated, this is a required parameter.) The Google Developers Console project ID or project number. This field has been deprecated and replaced by the parent field.
zone

string

Deprecated. (Although deprecated, this is a required parameter.) The name of the Google Compute Engine zone in which the cluster resides, or "-" for all zones. This field has been deprecated and replaced by the parent field.
parent

string

The parent (project and location) where the clusters will be listed. Specified in the format projects/*/locations/*. Location "-" matches all zones and all regions.

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 ListClustersResponse.

Subworkflow snippet

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

YAML

- list:
    call: googleapis.container.v1.projects.zones.clusters.list
    args:
        projectId: ...
        zone: ...
        parent: ...
    result: listResult

JSON

[
  {
    "list": {
      "call": "googleapis.container.v1.projects.zones.clusters.list",
      "args": {
        "projectId": "...",
        "zone": "...",
        "parent": "..."
      },
      "result": "listResult"
    }
  }
]