Google - API Kubernetes Engine

POST

/v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/addons

Sets the addons for a specific cluster.

Request

Path

Name	Data Type	Description
`clusterId`	string	Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.
`zone`	string	Required. 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.
`projectId`	string	Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

Body

Name Data Type Description

SetAddonsConfigRequest


                        SetAddonsConfigRequest

object

SetAddonsConfigRequest sets the addons associated with the cluster.

Properties


                        zone

string

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


                        projectId

string

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


                        name

string

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


                        clusterId

string

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


                        addonsConfig

AddonsConfig

Required. The desired configurations for the various addons available to run in the cluster.


                        AddonsConfig

object

Configuration for the addons that can be automatically spun up in the cluster, enabling additional functionality.

Properties

`networkPolicyConfig`	NetworkPolicyConfig	Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes.
`kubernetesDashboard`	KubernetesDashboard	Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards
`httpLoadBalancing`	HttpLoadBalancing	Configuration for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster.
`horizontalPodAutoscaling`	HorizontalPodAutoscaling	Configuration for the horizontal pod autoscaling feature, which increases or decreases the number of replica pods a replication controller has based on the resource usage of the existing pods.
`cloudRunConfig`	CloudRunConfig	Configuration for the Cloud Run addon, which allows the user to use a managed Knative service.

Responses

200Successful response

Body

Name Data Type Description

Operation


                        Operation

object

This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

Properties


                        zone

string

The name of the Google Compute Engine zone in which the operation is taking place. This field is deprecated, use location instead.


                        targetLink

string

Server-defined URL for the target of the operation.


                        statusMessage

string

If an error has occurred, a textual description of the error.


                        status

string
Allowed values:
- STATUS_UNSPECIFIED
- PENDING
- RUNNING
- DONE
- ABORTING

The current status of the operation.


                        startTime

string

[Output only] The time the operation started, in RFC3339 text format.


                        selfLink

string

Server-defined URL for the resource.


                        operationType

string
Allowed values:
- TYPE_UNSPECIFIED
- CREATE_CLUSTER
- DELETE_CLUSTER
- UPGRADE_MASTER
- UPGRADE_NODES
- REPAIR_CLUSTER
- UPDATE_CLUSTER
- CREATE_NODE_POOL
- DELETE_NODE_POOL
- SET_NODE_POOL_MANAGEMENT
- AUTO_REPAIR_NODES
- AUTO_UPGRADE_NODES
- SET_LABELS
- SET_MASTER_AUTH
- SET_NODE_POOL_SIZE
- SET_NETWORK_POLICY
- SET_MAINTENANCE_POLICY

The operation type.


                        nodepoolConditions

array [StatusCondition]

Which conditions caused the current node pool state.


                        StatusCondition

object

StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

Properties

`message`	string	Human-friendly representation of the condition
`code`	string Allowed values: - `UNKNOWN` - `GCE_STOCKOUT` - `GKE_SERVICE_ACCOUNT_DELETED` - `GCE_QUOTA_EXCEEDED` - `SET_BY_OPERATOR` - `CLOUD_KMS_KEY_ERROR`	Machine-friendly representation of the condition


                        name

string

The server-assigned ID for the operation.


                        location

string

[Output only] The name of the Google Compute Engine zone or region in which the cluster resides.


                        endTime

string

[Output only] The time the operation completed, in RFC3339 text format.


                        detail

string

Detailed operation progress, if available.


                        clusterConditions

array [StatusCondition]

Which conditions caused the current cluster state.


                        StatusCondition

object

StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

Properties

`message`	string	Human-friendly representation of the condition
`code`	string Allowed values: - `UNKNOWN` - `GCE_STOCKOUT` - `GKE_SERVICE_ACCOUNT_DELETED` - `GCE_QUOTA_EXCEEDED` - `SET_BY_OPERATOR` - `CLOUD_KMS_KEY_ERROR`	Machine-friendly representation of the condition

POST

/v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/legacyAbac

Enables or disables the ABAC authorization mechanism on a cluster.

Request

Path

Name	Data Type	Description
`clusterId`	string	Required. Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field.
`zone`	string	Required. 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.
`projectId`	string	Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

Body

Name Data Type Description

SetLegacyAbacRequest


                        SetLegacyAbacRequest

object

SetLegacyAbacRequest enables or disables the ABAC authorization mechanism for a cluster.

Properties

`zone`	string	Required. 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.
`projectId`	string	Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.
`name`	string	The name (project, location, cluster id) of the cluster to set legacy abac. Specified in the format 'projects//locations//clusters/*'.
`enabled`	boolean	Required. Whether ABAC authorization will be enabled in the cluster.
`clusterId`	string	Required. Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field.

Responses

200Successful response

Body

Name Data Type Description

Operation


                        Operation

object

This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

Properties


                        zone

string

The name of the Google Compute Engine zone in which the operation is taking place. This field is deprecated, use location instead.


                        targetLink

string

Server-defined URL for the target of the operation.


                        statusMessage

string

If an error has occurred, a textual description of the error.


                        status

string
Allowed values:
- STATUS_UNSPECIFIED
- PENDING
- RUNNING
- DONE
- ABORTING

The current status of the operation.


                        startTime

string

[Output only] The time the operation started, in RFC3339 text format.


                        selfLink

string

Server-defined URL for the resource.


                        operationType

string
Allowed values:
- TYPE_UNSPECIFIED
- CREATE_CLUSTER
- DELETE_CLUSTER
- UPGRADE_MASTER
- UPGRADE_NODES
- REPAIR_CLUSTER
- UPDATE_CLUSTER
- CREATE_NODE_POOL
- DELETE_NODE_POOL
- SET_NODE_POOL_MANAGEMENT
- AUTO_REPAIR_NODES
- AUTO_UPGRADE_NODES
- SET_LABELS
- SET_MASTER_AUTH
- SET_NODE_POOL_SIZE
- SET_NETWORK_POLICY
- SET_MAINTENANCE_POLICY

The operation type.


                        nodepoolConditions

array [StatusCondition]

Which conditions caused the current node pool state.


                        StatusCondition

object

StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

Properties

`message`	string	Human-friendly representation of the condition
`code`	string Allowed values: - `UNKNOWN` - `GCE_STOCKOUT` - `GKE_SERVICE_ACCOUNT_DELETED` - `GCE_QUOTA_EXCEEDED` - `SET_BY_OPERATOR` - `CLOUD_KMS_KEY_ERROR`	Machine-friendly representation of the condition


                        name

string

The server-assigned ID for the operation.


                        location

string

[Output only] The name of the Google Compute Engine zone or region in which the cluster resides.


                        endTime

string

[Output only] The time the operation completed, in RFC3339 text format.


                        detail

string

Detailed operation progress, if available.


                        clusterConditions

array [StatusCondition]

Which conditions caused the current cluster state.


                        StatusCondition

object

StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

Properties

`message`	string	Human-friendly representation of the condition
`code`	string Allowed values: - `UNKNOWN` - `GCE_STOCKOUT` - `GKE_SERVICE_ACCOUNT_DELETED` - `GCE_QUOTA_EXCEEDED` - `SET_BY_OPERATOR` - `CLOUD_KMS_KEY_ERROR`	Machine-friendly representation of the condition

POST

/v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/locations

Sets the locations for a specific cluster.

Request

Path

Name	Data Type	Description
`clusterId`	string	Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.
`zone`	string	Required. 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.
`projectId`	string	Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

Body

Name Data Type Description

SetLocationsRequest


                        SetLocationsRequest

object

SetLocationsRequest sets the locations of the cluster.

Properties

`zone`	string	Required. 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.
`projectId`	string	Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.
`name`	string	The name (project, location, cluster) of the cluster to set locations. Specified in the format 'projects//locations//clusters/*'.
`locations`	array [string]	Required. The desired list of Google Compute Engine zones in which the cluster's nodes should be located. Changing the locations a cluster is in will result in nodes being either created or removed from the cluster, depending on whether locations are being added or removed. This list must always include the cluster's primary zone.
`clusterId`	string	Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.

Responses

200Successful response

Body

Name Data Type Description

Operation


                        Operation

object

This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

Properties


                        zone

string

The name of the Google Compute Engine zone in which the operation is taking place. This field is deprecated, use location instead.


                        targetLink

string

Server-defined URL for the target of the operation.


                        statusMessage

string

If an error has occurred, a textual description of the error.


                        status

string
Allowed values:
- STATUS_UNSPECIFIED
- PENDING
- RUNNING
- DONE
- ABORTING

The current status of the operation.


                        startTime

string

[Output only] The time the operation started, in RFC3339 text format.


                        selfLink

string

Server-defined URL for the resource.


                        operationType

string
Allowed values:
- TYPE_UNSPECIFIED
- CREATE_CLUSTER
- DELETE_CLUSTER
- UPGRADE_MASTER
- UPGRADE_NODES
- REPAIR_CLUSTER
- UPDATE_CLUSTER
- CREATE_NODE_POOL
- DELETE_NODE_POOL
- SET_NODE_POOL_MANAGEMENT
- AUTO_REPAIR_NODES
- AUTO_UPGRADE_NODES
- SET_LABELS
- SET_MASTER_AUTH
- SET_NODE_POOL_SIZE
- SET_NETWORK_POLICY
- SET_MAINTENANCE_POLICY

The operation type.


                        nodepoolConditions

array [StatusCondition]

Which conditions caused the current node pool state.


                        StatusCondition

object

StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

Properties

`message`	string	Human-friendly representation of the condition
`code`	string Allowed values: - `UNKNOWN` - `GCE_STOCKOUT` - `GKE_SERVICE_ACCOUNT_DELETED` - `GCE_QUOTA_EXCEEDED` - `SET_BY_OPERATOR` - `CLOUD_KMS_KEY_ERROR`	Machine-friendly representation of the condition


                        name

string

The server-assigned ID for the operation.


                        location

string

[Output only] The name of the Google Compute Engine zone or region in which the cluster resides.


                        endTime

string

[Output only] The time the operation completed, in RFC3339 text format.


                        detail

string

Detailed operation progress, if available.


                        clusterConditions

array [StatusCondition]

Which conditions caused the current cluster state.


                        StatusCondition

object

StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

Properties

`message`	string	Human-friendly representation of the condition
`code`	string Allowed values: - `UNKNOWN` - `GCE_STOCKOUT` - `GKE_SERVICE_ACCOUNT_DELETED` - `GCE_QUOTA_EXCEEDED` - `SET_BY_OPERATOR` - `CLOUD_KMS_KEY_ERROR`	Machine-friendly representation of the condition

POST

/v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/logging

Sets the logging service for a specific cluster.

Request

Path

Name	Data Type	Description
`clusterId`	string	Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.
`zone`	string	Required. 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.
`projectId`	string	Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

Body

Name Data Type Description

SetLoggingServiceRequest


                        SetLoggingServiceRequest

object

SetLoggingServiceRequest sets the logging service of a cluster.

Properties

`zone`	string	Required. 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.
`projectId`	string	Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.
`name`	string	The name (project, location, cluster) of the cluster to set logging. Specified in the format 'projects//locations//clusters/*'.
`loggingService`	string	Required. The logging service the cluster should use to write metrics. Currently available options: "logging.googleapis.com" - the Google Cloud Logging service "none" - no metrics will be exported from the cluster
`clusterId`	string	Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.

Responses

200Successful response

Body

Name Data Type Description

Operation


                        Operation

object

This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

Properties


                        zone

string

The name of the Google Compute Engine zone in which the operation is taking place. This field is deprecated, use location instead.


                        targetLink

string

Server-defined URL for the target of the operation.


                        statusMessage

string

If an error has occurred, a textual description of the error.


                        status

string
Allowed values:
- STATUS_UNSPECIFIED
- PENDING
- RUNNING
- DONE
- ABORTING

The current status of the operation.


                        startTime

string

[Output only] The time the operation started, in RFC3339 text format.


                        selfLink

string

Server-defined URL for the resource.


                        operationType

string
Allowed values:
- TYPE_UNSPECIFIED
- CREATE_CLUSTER
- DELETE_CLUSTER
- UPGRADE_MASTER
- UPGRADE_NODES
- REPAIR_CLUSTER
- UPDATE_CLUSTER
- CREATE_NODE_POOL
- DELETE_NODE_POOL
- SET_NODE_POOL_MANAGEMENT
- AUTO_REPAIR_NODES
- AUTO_UPGRADE_NODES
- SET_LABELS
- SET_MASTER_AUTH
- SET_NODE_POOL_SIZE
- SET_NETWORK_POLICY
- SET_MAINTENANCE_POLICY

The operation type.


                        nodepoolConditions

array [StatusCondition]

Which conditions caused the current node pool state.


                        StatusCondition

object

StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

Properties

`message`	string	Human-friendly representation of the condition
`code`	string Allowed values: - `UNKNOWN` - `GCE_STOCKOUT` - `GKE_SERVICE_ACCOUNT_DELETED` - `GCE_QUOTA_EXCEEDED` - `SET_BY_OPERATOR` - `CLOUD_KMS_KEY_ERROR`	Machine-friendly representation of the condition


                        name

string

The server-assigned ID for the operation.


                        location

string

[Output only] The name of the Google Compute Engine zone or region in which the cluster resides.


                        endTime

string

[Output only] The time the operation completed, in RFC3339 text format.


                        detail

string

Detailed operation progress, if available.


                        clusterConditions

array [StatusCondition]

Which conditions caused the current cluster state.


                        StatusCondition

object

StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

Properties

`message`	string	Human-friendly representation of the condition
`code`	string Allowed values: - `UNKNOWN` - `GCE_STOCKOUT` - `GKE_SERVICE_ACCOUNT_DELETED` - `GCE_QUOTA_EXCEEDED` - `SET_BY_OPERATOR` - `CLOUD_KMS_KEY_ERROR`	Machine-friendly representation of the condition

POST

/v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/master

Updates the master for a specific cluster.

Request

Path

Name	Data Type	Description
`clusterId`	string	Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.
`zone`	string	Required. 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.
`projectId`	string	Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

Body

Name Data Type Description

UpdateMasterRequest


                        UpdateMasterRequest

object

UpdateMasterRequest updates the master of the cluster.

Properties

`zone`	string	Required. 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.
`projectId`	string	Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.
`name`	string	The name (project, location, cluster) of the cluster to update. Specified in the format 'projects//locations//clusters/*'.
`masterVersion`	string	Required. The Kubernetes version to change the master to. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: "latest": picks the highest valid Kubernetes version "1.X": picks the highest valid patch+gke.N patch in the 1.X version "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version "1.X.Y-gke.N": picks an explicit Kubernetes version "-": picks the default Kubernetes version
`clusterId`	string	Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.

Responses

200Successful response

Body

Name Data Type Description

Operation


                        Operation

object

This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

Properties


                        zone

string

The name of the Google Compute Engine zone in which the operation is taking place. This field is deprecated, use location instead.


                        targetLink

string

Server-defined URL for the target of the operation.


                        statusMessage

string

If an error has occurred, a textual description of the error.


                        status

string
Allowed values:
- STATUS_UNSPECIFIED
- PENDING
- RUNNING
- DONE
- ABORTING

The current status of the operation.


                        startTime

string

[Output only] The time the operation started, in RFC3339 text format.


                        selfLink

string

Server-defined URL for the resource.


                        operationType

string
Allowed values:
- TYPE_UNSPECIFIED
- CREATE_CLUSTER
- DELETE_CLUSTER
- UPGRADE_MASTER
- UPGRADE_NODES
- REPAIR_CLUSTER
- UPDATE_CLUSTER
- CREATE_NODE_POOL
- DELETE_NODE_POOL
- SET_NODE_POOL_MANAGEMENT
- AUTO_REPAIR_NODES
- AUTO_UPGRADE_NODES
- SET_LABELS
- SET_MASTER_AUTH
- SET_NODE_POOL_SIZE
- SET_NETWORK_POLICY
- SET_MAINTENANCE_POLICY

The operation type.


                        nodepoolConditions

array [StatusCondition]

Which conditions caused the current node pool state.


                        StatusCondition

object

StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

Properties

`message`	string	Human-friendly representation of the condition
`code`	string Allowed values: - `UNKNOWN` - `GCE_STOCKOUT` - `GKE_SERVICE_ACCOUNT_DELETED` - `GCE_QUOTA_EXCEEDED` - `SET_BY_OPERATOR` - `CLOUD_KMS_KEY_ERROR`	Machine-friendly representation of the condition


                        name

string

The server-assigned ID for the operation.


                        location

string

[Output only] The name of the Google Compute Engine zone or region in which the cluster resides.


                        endTime

string

[Output only] The time the operation completed, in RFC3339 text format.


                        detail

string

Detailed operation progress, if available.


                        clusterConditions

array [StatusCondition]

Which conditions caused the current cluster state.


                        StatusCondition

object

StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

Properties

`message`	string	Human-friendly representation of the condition
`code`	string Allowed values: - `UNKNOWN` - `GCE_STOCKOUT` - `GKE_SERVICE_ACCOUNT_DELETED` - `GCE_QUOTA_EXCEEDED` - `SET_BY_OPERATOR` - `CLOUD_KMS_KEY_ERROR`	Machine-friendly representation of the condition

POST

/v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/monitoring

Sets the monitoring service for a specific cluster.

Request

Path

Name	Data Type	Description
`clusterId`	string	Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.
`zone`	string	Required. 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.
`projectId`	string	Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

Body

Name Data Type Description

SetMonitoringServiceRequest


                        SetMonitoringServiceRequest

object

SetMonitoringServiceRequest sets the monitoring service of a cluster.

Properties

`zone`	string	Required. 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.
`projectId`	string	Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.
`name`	string	The name (project, location, cluster) of the cluster to set monitoring. Specified in the format 'projects//locations//clusters/*'.
`monitoringService`	string	Required. The monitoring service the cluster should use to write metrics. Currently available options: "monitoring.googleapis.com/kubernetes" - the Google Cloud Monitoring service with Kubernetes-native resource model "monitoring.googleapis.com" - the Google Cloud Monitoring service "none" - no metrics will be exported from the cluster
`clusterId`	string	Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.

Responses

200Successful response

Body

Name Data Type Description

Operation


                        Operation

object

This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

Properties


                        zone

string

The name of the Google Compute Engine zone in which the operation is taking place. This field is deprecated, use location instead.


                        targetLink

string

Server-defined URL for the target of the operation.


                        statusMessage

string

If an error has occurred, a textual description of the error.


                        status

string
Allowed values:
- STATUS_UNSPECIFIED
- PENDING
- RUNNING
- DONE
- ABORTING

The current status of the operation.


                        startTime

string

[Output only] The time the operation started, in RFC3339 text format.


                        selfLink

string

Server-defined URL for the resource.


                        operationType

string
Allowed values:
- TYPE_UNSPECIFIED
- CREATE_CLUSTER
- DELETE_CLUSTER
- UPGRADE_MASTER
- UPGRADE_NODES
- REPAIR_CLUSTER
- UPDATE_CLUSTER
- CREATE_NODE_POOL
- DELETE_NODE_POOL
- SET_NODE_POOL_MANAGEMENT
- AUTO_REPAIR_NODES
- AUTO_UPGRADE_NODES
- SET_LABELS
- SET_MASTER_AUTH
- SET_NODE_POOL_SIZE
- SET_NETWORK_POLICY
- SET_MAINTENANCE_POLICY

The operation type.


                        nodepoolConditions

array [StatusCondition]

Which conditions caused the current node pool state.


                        StatusCondition

object

StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

Properties

`message`	string	Human-friendly representation of the condition
`code`	string Allowed values: - `UNKNOWN` - `GCE_STOCKOUT` - `GKE_SERVICE_ACCOUNT_DELETED` - `GCE_QUOTA_EXCEEDED` - `SET_BY_OPERATOR` - `CLOUD_KMS_KEY_ERROR`	Machine-friendly representation of the condition


                        name

string

The server-assigned ID for the operation.


                        location

string

[Output only] The name of the Google Compute Engine zone or region in which the cluster resides.


                        endTime

string

[Output only] The time the operation completed, in RFC3339 text format.


                        detail

string

Detailed operation progress, if available.


                        clusterConditions

array [StatusCondition]

Which conditions caused the current cluster state.


                        StatusCondition

object

StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

Properties

`message`	string	Human-friendly representation of the condition
`code`	string Allowed values: - `UNKNOWN` - `GCE_STOCKOUT` - `GKE_SERVICE_ACCOUNT_DELETED` - `GCE_QUOTA_EXCEEDED` - `SET_BY_OPERATOR` - `CLOUD_KMS_KEY_ERROR`	Machine-friendly representation of the condition

POST

/v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/autoscaling

Sets the autoscaling settings for the specified node pool.

Request

Path

Name	Data Type	Description
`nodePoolId`	string	Required. Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field.
`clusterId`	string	Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.
`zone`	string	Required. 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.
`projectId`	string	Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

Body

Name Data Type Description

SetNodePoolAutoscalingRequest


                        SetNodePoolAutoscalingRequest

object

SetNodePoolAutoscalingRequest sets the autoscaler settings of a node pool.

Properties


                        zone

string

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


                        projectId

string

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


                        nodePoolId

string

Required. Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field.


                        name

string

The name (project, location, cluster, node pool) of the node pool to set autoscaler settings. Specified in the format 'projects//locations//clusters//nodePools/'.


                        clusterId

string

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


                        autoscaling

NodePoolAutoscaling

Required. Autoscaling configuration for the node pool.


                        NodePoolAutoscaling

object

NodePoolAutoscaling contains information required by cluster autoscaler to adjust the size of the node pool to the current cluster usage.

Properties

`minNodeCount`	integer	Minimum number of nodes in the NodePool. Must be >= 1 and <= max_node_count.
`maxNodeCount`	integer	Maximum number of nodes in the NodePool. Must be >= min_node_count. There has to enough quota to scale up the cluster.
`enabled`	boolean	Is autoscaling enabled for this node pool.
`autoprovisioned`	boolean	Can this node pool be deleted automatically.

Responses

200Successful response

Body

Name Data Type Description

Operation


                        Operation

object

This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

Properties


                        zone

string

The name of the Google Compute Engine zone in which the operation is taking place. This field is deprecated, use location instead.


                        targetLink

string

Server-defined URL for the target of the operation.


                        statusMessage

string

If an error has occurred, a textual description of the error.


                        status

string
Allowed values:
- STATUS_UNSPECIFIED
- PENDING
- RUNNING
- DONE
- ABORTING

The current status of the operation.


                        startTime

string

[Output only] The time the operation started, in RFC3339 text format.


                        selfLink

string

Server-defined URL for the resource.


                        operationType

string
Allowed values:
- TYPE_UNSPECIFIED
- CREATE_CLUSTER
- DELETE_CLUSTER
- UPGRADE_MASTER
- UPGRADE_NODES
- REPAIR_CLUSTER
- UPDATE_CLUSTER
- CREATE_NODE_POOL
- DELETE_NODE_POOL
- SET_NODE_POOL_MANAGEMENT
- AUTO_REPAIR_NODES
- AUTO_UPGRADE_NODES
- SET_LABELS
- SET_MASTER_AUTH
- SET_NODE_POOL_SIZE
- SET_NETWORK_POLICY
- SET_MAINTENANCE_POLICY

The operation type.


                        nodepoolConditions

array [StatusCondition]

Which conditions caused the current node pool state.


                        StatusCondition

object

StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

Properties

`message`	string	Human-friendly representation of the condition
`code`	string Allowed values: - `UNKNOWN` - `GCE_STOCKOUT` - `GKE_SERVICE_ACCOUNT_DELETED` - `GCE_QUOTA_EXCEEDED` - `SET_BY_OPERATOR` - `CLOUD_KMS_KEY_ERROR`	Machine-friendly representation of the condition


                        name

string

The server-assigned ID for the operation.


                        location

string

[Output only] The name of the Google Compute Engine zone or region in which the cluster resides.


                        endTime

string

[Output only] The time the operation completed, in RFC3339 text format.


                        detail

string

Detailed operation progress, if available.


                        clusterConditions

array [StatusCondition]

Which conditions caused the current cluster state.


                        StatusCondition

object

StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

Properties

`message`	string	Human-friendly representation of the condition
`code`	string Allowed values: - `UNKNOWN` - `GCE_STOCKOUT` - `GKE_SERVICE_ACCOUNT_DELETED` - `GCE_QUOTA_EXCEEDED` - `SET_BY_OPERATOR` - `CLOUD_KMS_KEY_ERROR`	Machine-friendly representation of the condition

POST

/v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/setManagement

Sets the NodeManagement options for a node pool.

Request

Path

Name	Data Type	Description
`nodePoolId`	string	Required. Deprecated. The name of the node pool to update. This field has been deprecated and replaced by the name field.
`clusterId`	string	Required. Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field.
`zone`	string	Required. 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.
`projectId`	string	Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

Body

Name Data Type Description

SetNodePoolManagementRequest


                        SetNodePoolManagementRequest

object

SetNodePoolManagementRequest sets the node management properties of a node pool.

Properties


                        zone

string

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


                        projectId

string

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


                        nodePoolId

string

Required. Deprecated. The name of the node pool to update. This field has been deprecated and replaced by the name field.


                        name

string

The name (project, location, cluster, node pool id) of the node pool to set management properties. Specified in the format 'projects//locations//clusters//nodePools/'.


                        management

NodeManagement

Required. NodeManagement configuration for the node pool.


                        NodeManagement

object

NodeManagement defines the set of node management services turned on for the node pool.

Properties

`upgradeOptions`	AutoUpgradeOptions	Specifies the Auto Upgrade knobs for the node pool.
`autoUpgrade`	boolean	A flag that specifies whether node auto-upgrade is enabled for the node pool. If enabled, node auto-upgrade helps keep the nodes in your node pool up to date with the latest release version of Kubernetes.
`autoRepair`	boolean	A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered.


                        clusterId

string

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

Responses

200Successful response

Body

Name Data Type Description

Operation


                        Operation

object

This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

Properties


                        zone

string

The name of the Google Compute Engine zone in which the operation is taking place. This field is deprecated, use location instead.


                        targetLink

string

Server-defined URL for the target of the operation.


                        statusMessage

string

If an error has occurred, a textual description of the error.


                        status

string
Allowed values:
- STATUS_UNSPECIFIED
- PENDING
- RUNNING
- DONE
- ABORTING

The current status of the operation.


                        startTime

string

[Output only] The time the operation started, in RFC3339 text format.


                        selfLink

string

Server-defined URL for the resource.


                        operationType

string
Allowed values:
- TYPE_UNSPECIFIED
- CREATE_CLUSTER
- DELETE_CLUSTER
- UPGRADE_MASTER
- UPGRADE_NODES
- REPAIR_CLUSTER
- UPDATE_CLUSTER
- CREATE_NODE_POOL
- DELETE_NODE_POOL
- SET_NODE_POOL_MANAGEMENT
- AUTO_REPAIR_NODES
- AUTO_UPGRADE_NODES
- SET_LABELS
- SET_MASTER_AUTH
- SET_NODE_POOL_SIZE
- SET_NETWORK_POLICY
- SET_MAINTENANCE_POLICY

The operation type.


                        nodepoolConditions

array [StatusCondition]

Which conditions caused the current node pool state.


                        StatusCondition

object

StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

Properties

`message`	string	Human-friendly representation of the condition
`code`	string Allowed values: - `UNKNOWN` - `GCE_STOCKOUT` - `GKE_SERVICE_ACCOUNT_DELETED` - `GCE_QUOTA_EXCEEDED` - `SET_BY_OPERATOR` - `CLOUD_KMS_KEY_ERROR`	Machine-friendly representation of the condition


                        name

string

The server-assigned ID for the operation.


                        location

string

[Output only] The name of the Google Compute Engine zone or region in which the cluster resides.


                        endTime

string

[Output only] The time the operation completed, in RFC3339 text format.


                        detail

string

Detailed operation progress, if available.


                        clusterConditions

array [StatusCondition]

Which conditions caused the current cluster state.


                        StatusCondition

object

StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

Properties

`message`	string	Human-friendly representation of the condition
`code`	string Allowed values: - `UNKNOWN` - `GCE_STOCKOUT` - `GKE_SERVICE_ACCOUNT_DELETED` - `GCE_QUOTA_EXCEEDED` - `SET_BY_OPERATOR` - `CLOUD_KMS_KEY_ERROR`	Machine-friendly representation of the condition

POST

/v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/setSize

Sets the size for a specific node pool.

Request

Path

Name	Data Type	Description
`nodePoolId`	string	Required. Deprecated. The name of the node pool to update. This field has been deprecated and replaced by the name field.
`clusterId`	string	Required. Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field.
`zone`	string	Required. 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.
`projectId`	string	Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

Body

Name Data Type Description

SetNodePoolSizeRequest


                        SetNodePoolSizeRequest

object

SetNodePoolSizeRequest sets the size a node pool.

Properties

`zone`	string	Required. 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.
`projectId`	string	Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.
`nodePoolId`	string	Required. Deprecated. The name of the node pool to update. This field has been deprecated and replaced by the name field.
`nodeCount`	integer	Required. The desired node count for the pool.
`name`	string	The name (project, location, cluster, node pool id) of the node pool to set size. Specified in the format 'projects//locations//clusters//nodePools/'.
`clusterId`	string	Required. Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field.

Responses

200Successful response

Body

Name Data Type Description

Operation


                        Operation

object

This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

Properties


                        zone

string

The name of the Google Compute Engine zone in which the operation is taking place. This field is deprecated, use location instead.


                        targetLink

string

Server-defined URL for the target of the operation.


                        statusMessage

string

If an error has occurred, a textual description of the error.


                        status

string
Allowed values:
- STATUS_UNSPECIFIED
- PENDING
- RUNNING
- DONE
- ABORTING

The current status of the operation.


                        startTime

string

[Output only] The time the operation started, in RFC3339 text format.


                        selfLink

string

Server-defined URL for the resource.


                        operationType

string
Allowed values:
- TYPE_UNSPECIFIED
- CREATE_CLUSTER
- DELETE_CLUSTER
- UPGRADE_MASTER
- UPGRADE_NODES
- REPAIR_CLUSTER
- UPDATE_CLUSTER
- CREATE_NODE_POOL
- DELETE_NODE_POOL
- SET_NODE_POOL_MANAGEMENT
- AUTO_REPAIR_NODES
- AUTO_UPGRADE_NODES
- SET_LABELS
- SET_MASTER_AUTH
- SET_NODE_POOL_SIZE
- SET_NETWORK_POLICY
- SET_MAINTENANCE_POLICY

The operation type.


                        nodepoolConditions

array [StatusCondition]

Which conditions caused the current node pool state.


                        StatusCondition

object

StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

Properties

`message`	string	Human-friendly representation of the condition
`code`	string Allowed values: - `UNKNOWN` - `GCE_STOCKOUT` - `GKE_SERVICE_ACCOUNT_DELETED` - `GCE_QUOTA_EXCEEDED` - `SET_BY_OPERATOR` - `CLOUD_KMS_KEY_ERROR`	Machine-friendly representation of the condition


                        name

string

The server-assigned ID for the operation.


                        location

string

[Output only] The name of the Google Compute Engine zone or region in which the cluster resides.


                        endTime

string

[Output only] The time the operation completed, in RFC3339 text format.


                        detail

string

Detailed operation progress, if available.


                        clusterConditions

array [StatusCondition]

Which conditions caused the current cluster state.


                        StatusCondition

object

StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

Properties

`message`	string	Human-friendly representation of the condition
`code`	string Allowed values: - `UNKNOWN` - `GCE_STOCKOUT` - `GKE_SERVICE_ACCOUNT_DELETED` - `GCE_QUOTA_EXCEEDED` - `SET_BY_OPERATOR` - `CLOUD_KMS_KEY_ERROR`	Machine-friendly representation of the condition

POST

/v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/update

Updates the version and/or image type for the specified node pool.

Request

Path

Name	Data Type	Description
`nodePoolId`	string	Required. Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field.
`clusterId`	string	Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.
`zone`	string	Required. 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.
`projectId`	string	Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

Body

Name Data Type Description

UpdateNodePoolRequest


                        UpdateNodePoolRequest

object

UpdateNodePoolRequests update a node pool's image and/or version.

Properties

`zone`	string	Required. 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.
`projectId`	string	Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.
`nodeVersion`	string	Required. The Kubernetes version to change the nodes to (typically an upgrade). Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: "latest": picks the highest valid Kubernetes version "1.X": picks the highest valid patch+gke.N patch in the 1.X version "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version "1.X.Y-gke.N": picks an explicit Kubernetes version "-": picks the Kubernetes master version
`nodePoolId`	string	Required. Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field.
`name`	string	The name (project, location, cluster, node pool) of the node pool to update. Specified in the format 'projects//locations//clusters//nodePools/'.
`imageType`	string	Required. The desired image type for the node pool.
`clusterId`	string	Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.

Responses

200Successful response

Body

Name Data Type Description

Operation


                        Operation

object

This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

Properties


                        zone

string

The name of the Google Compute Engine zone in which the operation is taking place. This field is deprecated, use location instead.


                        targetLink

string

Server-defined URL for the target of the operation.


                        statusMessage

string

If an error has occurred, a textual description of the error.


                        status

string
Allowed values:
- STATUS_UNSPECIFIED
- PENDING
- RUNNING
- DONE
- ABORTING

The current status of the operation.


                        startTime

string

[Output only] The time the operation started, in RFC3339 text format.


                        selfLink

string

Server-defined URL for the resource.


                        operationType

string
Allowed values:
- TYPE_UNSPECIFIED
- CREATE_CLUSTER
- DELETE_CLUSTER
- UPGRADE_MASTER
- UPGRADE_NODES
- REPAIR_CLUSTER
- UPDATE_CLUSTER
- CREATE_NODE_POOL
- DELETE_NODE_POOL
- SET_NODE_POOL_MANAGEMENT
- AUTO_REPAIR_NODES
- AUTO_UPGRADE_NODES
- SET_LABELS
- SET_MASTER_AUTH
- SET_NODE_POOL_SIZE
- SET_NETWORK_POLICY
- SET_MAINTENANCE_POLICY

The operation type.


                        nodepoolConditions

array [StatusCondition]

Which conditions caused the current node pool state.


                        StatusCondition

object

StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

Properties

`message`	string	Human-friendly representation of the condition
`code`	string Allowed values: - `UNKNOWN` - `GCE_STOCKOUT` - `GKE_SERVICE_ACCOUNT_DELETED` - `GCE_QUOTA_EXCEEDED` - `SET_BY_OPERATOR` - `CLOUD_KMS_KEY_ERROR`	Machine-friendly representation of the condition


                        name

string

The server-assigned ID for the operation.


                        location

string

[Output only] The name of the Google Compute Engine zone or region in which the cluster resides.


                        endTime

string

[Output only] The time the operation completed, in RFC3339 text format.


                        detail

string

Detailed operation progress, if available.


                        clusterConditions

array [StatusCondition]

Which conditions caused the current cluster state.


                        StatusCondition

object

StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

Properties

`message`	string	Human-friendly representation of the condition
`code`	string Allowed values: - `UNKNOWN` - `GCE_STOCKOUT` - `GKE_SERVICE_ACCOUNT_DELETED` - `GCE_QUOTA_EXCEEDED` - `SET_BY_OPERATOR` - `CLOUD_KMS_KEY_ERROR`	Machine-friendly representation of the condition

POST

/v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}:rollback

Rolls back a previously Aborted or Failed NodePool upgrade. This makes no changes if the last upgrade successfully completed.

Request

Path

Name	Data Type	Description
`nodePoolId`	string	Required. Deprecated. The name of the node pool to rollback. This field has been deprecated and replaced by the name field.
`clusterId`	string	Required. Deprecated. The name of the cluster to rollback. This field has been deprecated and replaced by the name field.
`zone`	string	Required. 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.
`projectId`	string	Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

Body

Name Data Type Description

RollbackNodePoolUpgradeRequest


                        RollbackNodePoolUpgradeRequest

object

RollbackNodePoolUpgradeRequest rollbacks the previously Aborted or Failed NodePool upgrade. This will be an no-op if the last upgrade successfully completed.

Properties

`zone`	string	Required. 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.
`projectId`	string	Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.
`nodePoolId`	string	Required. Deprecated. The name of the node pool to rollback. This field has been deprecated and replaced by the name field.
`name`	string	The name (project, location, cluster, node pool id) of the node poll to rollback upgrade. Specified in the format 'projects//locations//clusters//nodePools/'.
`clusterId`	string	Required. Deprecated. The name of the cluster to rollback. This field has been deprecated and replaced by the name field.

Responses

200Successful response

Body

Name Data Type Description

Operation


                        Operation

object

This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

Properties


                        zone

string

The name of the Google Compute Engine zone in which the operation is taking place. This field is deprecated, use location instead.


                        targetLink

string

Server-defined URL for the target of the operation.


                        statusMessage

string

If an error has occurred, a textual description of the error.


                        status

string
Allowed values:
- STATUS_UNSPECIFIED
- PENDING
- RUNNING
- DONE
- ABORTING

The current status of the operation.


                        startTime

string

[Output only] The time the operation started, in RFC3339 text format.


                        selfLink

string

Server-defined URL for the resource.


                        operationType

string
Allowed values:
- TYPE_UNSPECIFIED
- CREATE_CLUSTER
- DELETE_CLUSTER
- UPGRADE_MASTER
- UPGRADE_NODES
- REPAIR_CLUSTER
- UPDATE_CLUSTER
- CREATE_NODE_POOL
- DELETE_NODE_POOL
- SET_NODE_POOL_MANAGEMENT
- AUTO_REPAIR_NODES
- AUTO_UPGRADE_NODES
- SET_LABELS
- SET_MASTER_AUTH
- SET_NODE_POOL_SIZE
- SET_NETWORK_POLICY
- SET_MAINTENANCE_POLICY

The operation type.


                        nodepoolConditions

array [StatusCondition]

Which conditions caused the current node pool state.


                        StatusCondition

object

StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

Properties

`message`	string	Human-friendly representation of the condition
`code`	string Allowed values: - `UNKNOWN` - `GCE_STOCKOUT` - `GKE_SERVICE_ACCOUNT_DELETED` - `GCE_QUOTA_EXCEEDED` - `SET_BY_OPERATOR` - `CLOUD_KMS_KEY_ERROR`	Machine-friendly representation of the condition


                        name

string

The server-assigned ID for the operation.


                        location

string

[Output only] The name of the Google Compute Engine zone or region in which the cluster resides.


                        endTime

string

[Output only] The time the operation completed, in RFC3339 text format.


                        detail

string

Detailed operation progress, if available.


                        clusterConditions

array [StatusCondition]

Which conditions caused the current cluster state.


                        StatusCondition

object

StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

Properties

`message`	string	Human-friendly representation of the condition
`code`	string Allowed values: - `UNKNOWN` - `GCE_STOCKOUT` - `GKE_SERVICE_ACCOUNT_DELETED` - `GCE_QUOTA_EXCEEDED` - `SET_BY_OPERATOR` - `CLOUD_KMS_KEY_ERROR`	Machine-friendly representation of the condition

DELETE

/v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}

Deletes a node pool from a cluster.

Request

Path

Name	Data Type	Description
`nodePoolId`	string	Required. Deprecated. The name of the node pool to delete. This field has been deprecated and replaced by the name field.
`clusterId`	string	Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.
`zone`	string	Required. 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.
`projectId`	string	Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

Query

Name	Data Type	Description
`name`	string	The name (project, location, cluster, node pool id) of the node pool to delete. Specified in the format 'projects//locations//clusters//nodePools/'.

Responses

200Successful response

Body

Name Data Type Description

Operation


                        Operation

object

This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

Properties


                        zone

string

The name of the Google Compute Engine zone in which the operation is taking place. This field is deprecated, use location instead.


                        targetLink

string

Server-defined URL for the target of the operation.


                        statusMessage

string

If an error has occurred, a textual description of the error.


                        status

string
Allowed values:
- STATUS_UNSPECIFIED
- PENDING
- RUNNING
- DONE
- ABORTING

The current status of the operation.


                        startTime

string

[Output only] The time the operation started, in RFC3339 text format.


                        selfLink

string

Server-defined URL for the resource.


                        operationType

string
Allowed values:
- TYPE_UNSPECIFIED
- CREATE_CLUSTER
- DELETE_CLUSTER
- UPGRADE_MASTER
- UPGRADE_NODES
- REPAIR_CLUSTER
- UPDATE_CLUSTER
- CREATE_NODE_POOL
- DELETE_NODE_POOL
- SET_NODE_POOL_MANAGEMENT
- AUTO_REPAIR_NODES
- AUTO_UPGRADE_NODES
- SET_LABELS
- SET_MASTER_AUTH
- SET_NODE_POOL_SIZE
- SET_NETWORK_POLICY
- SET_MAINTENANCE_POLICY

The operation type.


                        nodepoolConditions

array [StatusCondition]

Which conditions caused the current node pool state.


                        StatusCondition

object

StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

Properties

`message`	string	Human-friendly representation of the condition
`code`	string Allowed values: - `UNKNOWN` - `GCE_STOCKOUT` - `GKE_SERVICE_ACCOUNT_DELETED` - `GCE_QUOTA_EXCEEDED` - `SET_BY_OPERATOR` - `CLOUD_KMS_KEY_ERROR`	Machine-friendly representation of the condition


                        name

string

The server-assigned ID for the operation.


                        location

string

[Output only] The name of the Google Compute Engine zone or region in which the cluster resides.


                        endTime

string

[Output only] The time the operation completed, in RFC3339 text format.


                        detail

string

Detailed operation progress, if available.


                        clusterConditions

array [StatusCondition]

Which conditions caused the current cluster state.


                        StatusCondition

object

StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

Properties

`message`	string	Human-friendly representation of the condition
`code`	string Allowed values: - `UNKNOWN` - `GCE_STOCKOUT` - `GKE_SERVICE_ACCOUNT_DELETED` - `GCE_QUOTA_EXCEEDED` - `SET_BY_OPERATOR` - `CLOUD_KMS_KEY_ERROR`	Machine-friendly representation of the condition

GET

/v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}

Retrieves the requested node pool.

Request

Path

Name	Data Type	Description
`nodePoolId`	string	Required. Deprecated. The name of the node pool. This field has been deprecated and replaced by the name field.
`clusterId`	string	Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.
`zone`	string	Required. 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.
`projectId`	string	Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

Query

Name	Data Type	Description
`name`	string	The name (project, location, cluster, node pool id) of the node pool to get. Specified in the format 'projects//locations//clusters//nodePools/'.

Responses

200Successful response

Body

Name Data Type Description

NodePool


                        NodePool

object

NodePool contains the name and configuration for a cluster's node pool. Node pools are a set of nodes (i.e. VM's), with a common configuration and specification, under the control of the cluster master. They may have a set of Kubernetes labels applied to them, which may be used to reference them during pod scheduling. They may also be resized up or down, to accommodate the workload.

Properties


                        version

string

The version of the Kubernetes of this node.


                        statusMessage

string

[Output only] Additional information about the current status of this node pool instance, if available.


                        status

string
Allowed values:
- STATUS_UNSPECIFIED
- PROVISIONING
- RUNNING
- RUNNING_WITH_ERROR
- RECONCILING
- STOPPING
- ERROR

[Output only] The status of the nodes in this pool instance.


                        selfLink

string

[Output only] Server-defined URL for the resource.


                        podIpv4CidrSize

integer

[Output only] The pod CIDR block size per node in this node pool.


                        name

string

The name of the node pool.


                        maxPodsConstraint

MaxPodsConstraint

The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool.


                        MaxPodsConstraint

object

Constraints applied to pods.

Properties


                        maxPodsPerNode

string

Constraint enforced on the max num of pods per node.


                        management

NodeManagement

NodeManagement configuration for this NodePool.


                        NodeManagement

object

NodeManagement defines the set of node management services turned on for the node pool.

Properties

`upgradeOptions`	AutoUpgradeOptions	Specifies the Auto Upgrade knobs for the node pool.
`autoUpgrade`	boolean	A flag that specifies whether node auto-upgrade is enabled for the node pool. If enabled, node auto-upgrade helps keep the nodes in your node pool up to date with the latest release version of Kubernetes.
`autoRepair`	boolean	A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered.


                        instanceGroupUrls

array [string]

[Output only] The resource URLs of the managed instance groups associated with this node pool.


                        initialNodeCount

integer

The initial node count for the pool. You must ensure that your Compute Engine resource quota is sufficient for this number of instances. You must also have available firewall and routes quota.


                        config

NodeConfig

The node configuration of the pool.


                        NodeConfig

object

Parameters that describe the nodes in a cluster.

Properties

`taints`	array [NodeTaint]	List of kubernetes taints to be applied to each node. For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/
`tags`	array [string]	The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster or node pool creation. Each tag within the list must comply with RFC1035.
`shieldedInstanceConfig`	ShieldedInstanceConfig	Shielded Instance options.
`serviceAccount`	string	The Google Cloud Platform Service Account to be used by the node VMs. If no Service Account is specified, the "default" service account is used.
`preemptible`	boolean	Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances.
`oauthScopes`	array [string]	The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with gcr.io (the Google Container Registry). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.
`minCpuPlatform`	string	Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read how to specify min CPU platform
`metadata`	object	The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: "cluster-location" "cluster-name" "cluster-uid" "configure-sh" "containerd-configure-sh" "enable-os-login" "gci-update-strategy" "gci-ensure-gke-docker" "instance-template" "kube-env" "startup-script" "user-data" "disable-address-manager" "windows-startup-script-ps1" "common-psm1" "k8s-node-setup-psm1" "install-ssh-psm1" "user-profile-psm1" "serial-port-logging-enable" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB.
`machineType`	string	The name of a Google Compute Engine machine type (e.g. `n1-standard-1`). If unspecified, the default machine type is `n1-standard-1`.
`localSsdCount`	integer	The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information.
`labels`	object	The map of Kubernetes labels (key/value pairs) to be applied to each node. These will added in addition to any default label(s) that Kubernetes may apply to the node. In case of conflict in label keys, the applied set may differ depending on the Kubernetes version -- it's best to assume the behavior is undefined and conflicts should be avoided. For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/
`imageType`	string	The image type to use for this node. Note that for a given image type, the latest version of it will be used.
`diskType`	string	Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd') If unspecified, the default disk type is 'pd-standard'
`diskSizeGb`	integer	Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB.
`accelerators`	array [AcceleratorConfig]	A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs.


                        conditions

array [StatusCondition]

Which conditions caused the current node pool state.


                        StatusCondition

object

StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

Properties

`message`	string	Human-friendly representation of the condition
`code`	string Allowed values: - `UNKNOWN` - `GCE_STOCKOUT` - `GKE_SERVICE_ACCOUNT_DELETED` - `GCE_QUOTA_EXCEEDED` - `SET_BY_OPERATOR` - `CLOUD_KMS_KEY_ERROR`	Machine-friendly representation of the condition


                        autoscaling

NodePoolAutoscaling

Autoscaler configuration for this NodePool. Autoscaler is enabled only if a valid configuration is present.


                        NodePoolAutoscaling

object

NodePoolAutoscaling contains information required by cluster autoscaler to adjust the size of the node pool to the current cluster usage.

Properties

`minNodeCount`	integer	Minimum number of nodes in the NodePool. Must be >= 1 and <= max_node_count.
`maxNodeCount`	integer	Maximum number of nodes in the NodePool. Must be >= min_node_count. There has to enough quota to scale up the cluster.
`enabled`	boolean	Is autoscaling enabled for this node pool.
`autoprovisioned`	boolean	Can this node pool be deleted automatically.

GET

/v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools

Lists the node pools for a cluster.

Request

Path

Name	Data Type	Description
`clusterId`	string	Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field.
`zone`	string	Required. Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the parent field.
`projectId`	string	Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the parent field.

Query

Name	Data Type	Description
`parent`	string	The parent (project, location, cluster id) where the node pools will be listed. Specified in the format 'projects//locations//clusters/*'.

Responses

200Successful response

Body

Name Data Type Description

ListNodePoolsResponse


                        ListNodePoolsResponse

object

ListNodePoolsResponse is the result of ListNodePoolsRequest.

Properties


                        nodePools

array [NodePool]

A list of node pools for a cluster.


                        NodePool

object

NodePool contains the name and configuration for a cluster's node pool. Node pools are a set of nodes (i.e. VM's), with a common configuration and specification, under the control of the cluster master. They may have a set of Kubernetes labels applied to them, which may be used to reference them during pod scheduling. They may also be resized up or down, to accommodate the workload.

Properties

`version`	string	The version of the Kubernetes of this node.
`statusMessage`	string	[Output only] Additional information about the current status of this node pool instance, if available.
`status`	string Allowed values: - `STATUS_UNSPECIFIED` - `PROVISIONING` - `RUNNING` - `RUNNING_WITH_ERROR` - `RECONCILING` - `STOPPING` - `ERROR`	[Output only] The status of the nodes in this pool instance.
`selfLink`	string	[Output only] Server-defined URL for the resource.
`podIpv4CidrSize`	integer	[Output only] The pod CIDR block size per node in this node pool.
`name`	string	The name of the node pool.
`maxPodsConstraint`	MaxPodsConstraint	The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool.
`management`	NodeManagement	NodeManagement configuration for this NodePool.
`instanceGroupUrls`	array [string]	[Output only] The resource URLs of the managed instance groups associated with this node pool.
`initialNodeCount`	integer	The initial node count for the pool. You must ensure that your Compute Engine resource quota is sufficient for this number of instances. You must also have available firewall and routes quota.
`config`	NodeConfig	The node configuration of the pool.
`conditions`	array [StatusCondition]	Which conditions caused the current node pool state.
`autoscaling`	NodePoolAutoscaling	Autoscaler configuration for this NodePool. Autoscaler is enabled only if a valid configuration is present.

POST

/v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools

Creates a node pool for a cluster.

Request

Path

Name	Data Type	Description
`clusterId`	string	Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field.
`zone`	string	Required. Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the parent field.
`projectId`	string	Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the parent field.

Body

Name Data Type Description

CreateNodePoolRequest


                        CreateNodePoolRequest

object

CreateNodePoolRequest creates a node pool for a cluster.

Properties


                        zone

string

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


                        projectId

string

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


                        parent

string

The parent (project, location, cluster id) where the node pool will be created. Specified in the format 'projects//locations//clusters/*'.


                        nodePool

NodePool

Required. The node pool to create.


                        NodePool

object

NodePool contains the name and configuration for a cluster's node pool. Node pools are a set of nodes (i.e. VM's), with a common configuration and specification, under the control of the cluster master. They may have a set of Kubernetes labels applied to them, which may be used to reference them during pod scheduling. They may also be resized up or down, to accommodate the workload.

Properties

`version`	string	The version of the Kubernetes of this node.
`statusMessage`	string	[Output only] Additional information about the current status of this node pool instance, if available.
`status`	string Allowed values: - `STATUS_UNSPECIFIED` - `PROVISIONING` - `RUNNING` - `RUNNING_WITH_ERROR` - `RECONCILING` - `STOPPING` - `ERROR`	[Output only] The status of the nodes in this pool instance.
`selfLink`	string	[Output only] Server-defined URL for the resource.
`podIpv4CidrSize`	integer	[Output only] The pod CIDR block size per node in this node pool.
`name`	string	The name of the node pool.
`maxPodsConstraint`	MaxPodsConstraint	The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool.
`management`	NodeManagement	NodeManagement configuration for this NodePool.
`instanceGroupUrls`	array [string]	[Output only] The resource URLs of the managed instance groups associated with this node pool.
`initialNodeCount`	integer	The initial node count for the pool. You must ensure that your Compute Engine resource quota is sufficient for this number of instances. You must also have available firewall and routes quota.
`config`	NodeConfig	The node configuration of the pool.
`conditions`	array [StatusCondition]	Which conditions caused the current node pool state.
`autoscaling`	NodePoolAutoscaling	Autoscaler configuration for this NodePool. Autoscaler is enabled only if a valid configuration is present.


                        clusterId

string

Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field.

Responses

200Successful response

Body

Name Data Type Description

Operation


                        Operation

object

This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

Properties


                        zone

string

The name of the Google Compute Engine zone in which the operation is taking place. This field is deprecated, use location instead.


                        targetLink

string

Server-defined URL for the target of the operation.


                        statusMessage

string

If an error has occurred, a textual description of the error.


                        status

string
Allowed values:
- STATUS_UNSPECIFIED
- PENDING
- RUNNING
- DONE
- ABORTING

The current status of the operation.


                        startTime

string

[Output only] The time the operation started, in RFC3339 text format.


                        selfLink

string

Server-defined URL for the resource.


                        operationType

string
Allowed values:
- TYPE_UNSPECIFIED
- CREATE_CLUSTER
- DELETE_CLUSTER
- UPGRADE_MASTER
- UPGRADE_NODES
- REPAIR_CLUSTER
- UPDATE_CLUSTER
- CREATE_NODE_POOL
- DELETE_NODE_POOL
- SET_NODE_POOL_MANAGEMENT
- AUTO_REPAIR_NODES
- AUTO_UPGRADE_NODES
- SET_LABELS
- SET_MASTER_AUTH
- SET_NODE_POOL_SIZE
- SET_NETWORK_POLICY
- SET_MAINTENANCE_POLICY

The operation type.


                        nodepoolConditions

array [StatusCondition]

Which conditions caused the current node pool state.


                        StatusCondition

object

StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

Properties

`message`	string	Human-friendly representation of the condition
`code`	string Allowed values: - `UNKNOWN` - `GCE_STOCKOUT` - `GKE_SERVICE_ACCOUNT_DELETED` - `GCE_QUOTA_EXCEEDED` - `SET_BY_OPERATOR` - `CLOUD_KMS_KEY_ERROR`	Machine-friendly representation of the condition


                        name

string

The server-assigned ID for the operation.


                        location

string

[Output only] The name of the Google Compute Engine zone or region in which the cluster resides.


                        endTime

string

[Output only] The time the operation completed, in RFC3339 text format.


                        detail

string

Detailed operation progress, if available.


                        clusterConditions

array [StatusCondition]

Which conditions caused the current cluster state.


                        StatusCondition

object

StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

Properties

`message`	string	Human-friendly representation of the condition
`code`	string Allowed values: - `UNKNOWN` - `GCE_STOCKOUT` - `GKE_SERVICE_ACCOUNT_DELETED` - `GCE_QUOTA_EXCEEDED` - `SET_BY_OPERATOR` - `CLOUD_KMS_KEY_ERROR`	Machine-friendly representation of the condition

POST

/v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/resourceLabels

Sets labels on a cluster.

Request

Path

Name	Data Type	Description
`clusterId`	string	Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.
`zone`	string	Required. 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.
`projectId`	string	Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

Body

Name Data Type Description

SetLabelsRequest


                        SetLabelsRequest

object

SetLabelsRequest sets the Google Cloud Platform labels on a Google Container Engine cluster, which will in turn set them for Google Compute Engine resources used by that cluster

Properties

`zone`	string	Required. 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.
`resourceLabels`	object	Required. The labels to set for that cluster.
`projectId`	string	Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.
`name`	string	The name (project, location, cluster id) of the cluster to set labels. Specified in the format 'projects//locations//clusters/*'.
`labelFingerprint`	string	Required. The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Kubernetes Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash when updating or changing labels. Make a `get()` request to the resource to get the latest fingerprint.
`clusterId`	string	Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.

Responses

200Successful response

Body

Name Data Type Description

Operation


                        Operation

object

This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

Properties


                        zone

string

The name of the Google Compute Engine zone in which the operation is taking place. This field is deprecated, use location instead.


                        targetLink

string

Server-defined URL for the target of the operation.


                        statusMessage

string

If an error has occurred, a textual description of the error.


                        status

string
Allowed values:
- STATUS_UNSPECIFIED
- PENDING
- RUNNING
- DONE
- ABORTING

The current status of the operation.


                        startTime

string

[Output only] The time the operation started, in RFC3339 text format.


                        selfLink

string

Server-defined URL for the resource.


                        operationType

string
Allowed values:
- TYPE_UNSPECIFIED
- CREATE_CLUSTER
- DELETE_CLUSTER
- UPGRADE_MASTER
- UPGRADE_NODES
- REPAIR_CLUSTER
- UPDATE_CLUSTER
- CREATE_NODE_POOL
- DELETE_NODE_POOL
- SET_NODE_POOL_MANAGEMENT
- AUTO_REPAIR_NODES
- AUTO_UPGRADE_NODES
- SET_LABELS
- SET_MASTER_AUTH
- SET_NODE_POOL_SIZE
- SET_NETWORK_POLICY
- SET_MAINTENANCE_POLICY

The operation type.


                        nodepoolConditions

array [StatusCondition]

Which conditions caused the current node pool state.


                        StatusCondition

object

StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

Properties

`message`	string	Human-friendly representation of the condition
`code`	string Allowed values: - `UNKNOWN` - `GCE_STOCKOUT` - `GKE_SERVICE_ACCOUNT_DELETED` - `GCE_QUOTA_EXCEEDED` - `SET_BY_OPERATOR` - `CLOUD_KMS_KEY_ERROR`	Machine-friendly representation of the condition


                        name

string

The server-assigned ID for the operation.


                        location

string

[Output only] The name of the Google Compute Engine zone or region in which the cluster resides.


                        endTime

string

[Output only] The time the operation completed, in RFC3339 text format.


                        detail

string

Detailed operation progress, if available.


                        clusterConditions

array [StatusCondition]

Which conditions caused the current cluster state.


                        StatusCondition

object

StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

Properties

`message`	string	Human-friendly representation of the condition
`code`	string Allowed values: - `UNKNOWN` - `GCE_STOCKOUT` - `GKE_SERVICE_ACCOUNT_DELETED` - `GCE_QUOTA_EXCEEDED` - `SET_BY_OPERATOR` - `CLOUD_KMS_KEY_ERROR`	Machine-friendly representation of the condition

POST

/v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:completeIpRotation

Completes master IP rotation.

Request

Path

Name	Data Type	Description
`clusterId`	string	Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.
`zone`	string	Required. 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.
`projectId`	string	Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

Body

Name Data Type Description

CompleteIPRotationRequest


                        CompleteIPRotationRequest

object

CompleteIPRotationRequest moves the cluster master back into single-IP mode.

Properties

`zone`	string	Required. 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.
`projectId`	string	Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.
`name`	string	The name (project, location, cluster id) of the cluster to complete IP rotation. Specified in the format 'projects//locations//clusters/*'.
`clusterId`	string	Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.

Responses

200Successful response

Body

Name Data Type Description

Operation


                        Operation

object

This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

Properties


                        zone

string

The name of the Google Compute Engine zone in which the operation is taking place. This field is deprecated, use location instead.


                        targetLink

string

Server-defined URL for the target of the operation.


                        statusMessage

string

If an error has occurred, a textual description of the error.


                        status

string
Allowed values:
- STATUS_UNSPECIFIED
- PENDING
- RUNNING
- DONE
- ABORTING

The current status of the operation.


                        startTime

string

[Output only] The time the operation started, in RFC3339 text format.


                        selfLink

string

Server-defined URL for the resource.


                        operationType

string
Allowed values:
- TYPE_UNSPECIFIED
- CREATE_CLUSTER
- DELETE_CLUSTER
- UPGRADE_MASTER
- UPGRADE_NODES
- REPAIR_CLUSTER
- UPDATE_CLUSTER
- CREATE_NODE_POOL
- DELETE_NODE_POOL
- SET_NODE_POOL_MANAGEMENT
- AUTO_REPAIR_NODES
- AUTO_UPGRADE_NODES
- SET_LABELS
- SET_MASTER_AUTH
- SET_NODE_POOL_SIZE
- SET_NETWORK_POLICY
- SET_MAINTENANCE_POLICY

The operation type.


                        nodepoolConditions

array [StatusCondition]

Which conditions caused the current node pool state.


                        StatusCondition

object

StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

Properties

`message`	string	Human-friendly representation of the condition
`code`	string Allowed values: - `UNKNOWN` - `GCE_STOCKOUT` - `GKE_SERVICE_ACCOUNT_DELETED` - `GCE_QUOTA_EXCEEDED` - `SET_BY_OPERATOR` - `CLOUD_KMS_KEY_ERROR`	Machine-friendly representation of the condition


                        name

string

The server-assigned ID for the operation.


                        location

string

[Output only] The name of the Google Compute Engine zone or region in which the cluster resides.


                        endTime

string

[Output only] The time the operation completed, in RFC3339 text format.


                        detail

string

Detailed operation progress, if available.


                        clusterConditions

array [StatusCondition]

Which conditions caused the current cluster state.


                        StatusCondition

object

StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

Properties

`message`	string	Human-friendly representation of the condition
`code`	string Allowed values: - `UNKNOWN` - `GCE_STOCKOUT` - `GKE_SERVICE_ACCOUNT_DELETED` - `GCE_QUOTA_EXCEEDED` - `SET_BY_OPERATOR` - `CLOUD_KMS_KEY_ERROR`	Machine-friendly representation of the condition

POST

/v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setMaintenancePolicy

Sets the maintenance policy for a cluster.

Request

Path

Name	Data Type	Description
`clusterId`	string	Required. The name of the cluster to update.
`zone`	string	Required. The name of the Google Compute Engine zone in which the cluster resides.
`projectId`	string	Required. The Google Developers Console project ID or project number.

Body

Name Data Type Description

SetMaintenancePolicyRequest


                        SetMaintenancePolicyRequest

object

SetMaintenancePolicyRequest sets the maintenance policy for a cluster.

Properties


                        zone

string

Required. The name of the Google Compute Engine zone in which the cluster resides.


                        projectId

string

Required. The Google Developers Console project ID or project number.


                        name

string

The name (project, location, cluster id) of the cluster to set maintenance policy. Specified in the format 'projects//locations//clusters/*'.


                        maintenancePolicy

MaintenancePolicy

Required. The maintenance policy to be set for the cluster. An empty field clears the existing maintenance policy.


                        MaintenancePolicy

object

MaintenancePolicy defines the maintenance policy to be used for the cluster.

Properties

`window`	MaintenanceWindow	Specifies the maintenance window in which maintenance may be performed.
`resourceVersion`	string	A hash identifying the version of this policy, so that updates to fields of the policy won't accidentally undo intermediate changes (and so that users of the API unaware of some fields won't accidentally remove other fields). Make a `get()` request to the cluster to get the current resource version and include it with requests to set the policy.


                        clusterId

string

Required. The name of the cluster to update.

Responses

200Successful response

Body

Name Data Type Description

Operation


                        Operation

object

This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

Properties


                        zone

string

The name of the Google Compute Engine zone in which the operation is taking place. This field is deprecated, use location instead.


                        targetLink

string

Server-defined URL for the target of the operation.


                        statusMessage

string

If an error has occurred, a textual description of the error.


                        status

string
Allowed values:
- STATUS_UNSPECIFIED
- PENDING
- RUNNING
- DONE
- ABORTING

The current status of the operation.


                        startTime

string

[Output only] The time the operation started, in RFC3339 text format.


                        selfLink

string

Server-defined URL for the resource.


                        operationType

string
Allowed values:
- TYPE_UNSPECIFIED
- CREATE_CLUSTER
- DELETE_CLUSTER
- UPGRADE_MASTER
- UPGRADE_NODES
- REPAIR_CLUSTER
- UPDATE_CLUSTER
- CREATE_NODE_POOL
- DELETE_NODE_POOL
- SET_NODE_POOL_MANAGEMENT
- AUTO_REPAIR_NODES
- AUTO_UPGRADE_NODES
- SET_LABELS
- SET_MASTER_AUTH
- SET_NODE_POOL_SIZE
- SET_NETWORK_POLICY
- SET_MAINTENANCE_POLICY

The operation type.


                        nodepoolConditions

array [StatusCondition]

Which conditions caused the current node pool state.


                        StatusCondition

object

StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

Properties

`message`	string	Human-friendly representation of the condition
`code`	string Allowed values: - `UNKNOWN` - `GCE_STOCKOUT` - `GKE_SERVICE_ACCOUNT_DELETED` - `GCE_QUOTA_EXCEEDED` - `SET_BY_OPERATOR` - `CLOUD_KMS_KEY_ERROR`	Machine-friendly representation of the condition


                        name

string

The server-assigned ID for the operation.


                        location

string

[Output only] The name of the Google Compute Engine zone or region in which the cluster resides.


                        endTime

string

[Output only] The time the operation completed, in RFC3339 text format.


                        detail

string

Detailed operation progress, if available.


                        clusterConditions

array [StatusCondition]

Which conditions caused the current cluster state.


                        StatusCondition

object

StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

Properties

`message`	string	Human-friendly representation of the condition
`code`	string Allowed values: - `UNKNOWN` - `GCE_STOCKOUT` - `GKE_SERVICE_ACCOUNT_DELETED` - `GCE_QUOTA_EXCEEDED` - `SET_BY_OPERATOR` - `CLOUD_KMS_KEY_ERROR`	Machine-friendly representation of the condition

POST

/v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setMasterAuth

Sets master auth materials. Currently supports changing the admin password or a specific cluster, either via password generation or explicitly setting the password.

Request

Path

Name	Data Type	Description
`clusterId`	string	Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.
`zone`	string	Required. 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.
`projectId`	string	Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

Body

Name Data Type Description

SetMasterAuthRequest


                        SetMasterAuthRequest

object

SetMasterAuthRequest updates the admin password of a cluster.

Properties


                        zone

string

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


                        update

MasterAuth

Required. A description of the update.


                        MasterAuth

object

The authentication information for accessing the master endpoint. Authentication can be done using HTTP basic auth or using client certificates.

Properties

`username`	string	The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string).
`password`	string	The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty.
`clusterCaCertificate`	string	[Output only] Base64-encoded public certificate that is the root of trust for the cluster.
`clientKey`	string	[Output only] Base64-encoded private key used by clients to authenticate to the cluster endpoint.
`clientCertificateConfig`	ClientCertificateConfig	Configuration for client certificate authentication on the cluster. For clusters before v1.12, if no configuration is specified, a client certificate is issued.
`clientCertificate`	string	[Output only] Base64-encoded public certificate used by clients to authenticate to the cluster endpoint.


                        projectId

string

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


                        name

string

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


                        clusterId

string

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


                        action

string
Allowed values:
- UNKNOWN
- SET_PASSWORD
- GENERATE_PASSWORD
- SET_USERNAME

Required. The exact form of action to be taken on the master auth.

Responses

200Successful response

Body

Name Data Type Description

Operation


                        Operation

object

This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

Properties


                        zone

string

The name of the Google Compute Engine zone in which the operation is taking place. This field is deprecated, use location instead.


                        targetLink

string

Server-defined URL for the target of the operation.


                        statusMessage

string

If an error has occurred, a textual description of the error.


                        status

string
Allowed values:
- STATUS_UNSPECIFIED
- PENDING
- RUNNING
- DONE
- ABORTING

The current status of the operation.


                        startTime

string

[Output only] The time the operation started, in RFC3339 text format.


                        selfLink

string

Server-defined URL for the resource.


                        operationType

string
Allowed values:
- TYPE_UNSPECIFIED
- CREATE_CLUSTER
- DELETE_CLUSTER
- UPGRADE_MASTER
- UPGRADE_NODES
- REPAIR_CLUSTER
- UPDATE_CLUSTER
- CREATE_NODE_POOL
- DELETE_NODE_POOL
- SET_NODE_POOL_MANAGEMENT
- AUTO_REPAIR_NODES
- AUTO_UPGRADE_NODES
- SET_LABELS
- SET_MASTER_AUTH
- SET_NODE_POOL_SIZE
- SET_NETWORK_POLICY
- SET_MAINTENANCE_POLICY

The operation type.


                        nodepoolConditions

array [StatusCondition]

Which conditions caused the current node pool state.


                        StatusCondition

object

StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

Properties

`message`	string	Human-friendly representation of the condition
`code`	string Allowed values: - `UNKNOWN` - `GCE_STOCKOUT` - `GKE_SERVICE_ACCOUNT_DELETED` - `GCE_QUOTA_EXCEEDED` - `SET_BY_OPERATOR` - `CLOUD_KMS_KEY_ERROR`	Machine-friendly representation of the condition


                        name

string

The server-assigned ID for the operation.


                        location

string

[Output only] The name of the Google Compute Engine zone or region in which the cluster resides.


                        endTime

string

[Output only] The time the operation completed, in RFC3339 text format.


                        detail

string

Detailed operation progress, if available.


                        clusterConditions

array [StatusCondition]

Which conditions caused the current cluster state.


                        StatusCondition

object

StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

Properties

`message`	string	Human-friendly representation of the condition
`code`	string Allowed values: - `UNKNOWN` - `GCE_STOCKOUT` - `GKE_SERVICE_ACCOUNT_DELETED` - `GCE_QUOTA_EXCEEDED` - `SET_BY_OPERATOR` - `CLOUD_KMS_KEY_ERROR`	Machine-friendly representation of the condition

POST

/v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setNetworkPolicy

Enables or disables Network Policy for a cluster.

Request

Path

Name	Data Type	Description
`clusterId`	string	Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.
`zone`	string	Required. 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.
`projectId`	string	Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

Body

Name Data Type Description

SetNetworkPolicyRequest


                        SetNetworkPolicyRequest

object

SetNetworkPolicyRequest enables/disables network policy for a cluster.

Properties


                        zone

string

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


                        projectId

string

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


                        networkPolicy

NetworkPolicy

Required. Configuration options for the NetworkPolicy feature.


                        NetworkPolicy

object

Configuration options for the NetworkPolicy feature. https://kubernetes.io/docs/concepts/services-networking/networkpolicies/

Properties

`provider`	string Allowed values: - `PROVIDER_UNSPECIFIED` - `CALICO`	The selected network policy provider.
`enabled`	boolean	Whether network policy is enabled on the cluster.


                        name

string

The name (project, location, cluster id) of the cluster to set networking policy. Specified in the format 'projects//locations//clusters/*'.


                        clusterId

string

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

Responses

200Successful response

Body

Name Data Type Description

Operation


                        Operation

object

This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

Properties


                        zone

string

The name of the Google Compute Engine zone in which the operation is taking place. This field is deprecated, use location instead.


                        targetLink

string

Server-defined URL for the target of the operation.


                        statusMessage

string

If an error has occurred, a textual description of the error.


                        status

string
Allowed values:
- STATUS_UNSPECIFIED
- PENDING
- RUNNING
- DONE
- ABORTING

The current status of the operation.


                        startTime

string

[Output only] The time the operation started, in RFC3339 text format.


                        selfLink

string

Server-defined URL for the resource.


                        operationType

string
Allowed values:
- TYPE_UNSPECIFIED
- CREATE_CLUSTER
- DELETE_CLUSTER
- UPGRADE_MASTER
- UPGRADE_NODES
- REPAIR_CLUSTER
- UPDATE_CLUSTER
- CREATE_NODE_POOL
- DELETE_NODE_POOL
- SET_NODE_POOL_MANAGEMENT
- AUTO_REPAIR_NODES
- AUTO_UPGRADE_NODES
- SET_LABELS
- SET_MASTER_AUTH
- SET_NODE_POOL_SIZE
- SET_NETWORK_POLICY
- SET_MAINTENANCE_POLICY

The operation type.


                        nodepoolConditions

array [StatusCondition]

Which conditions caused the current node pool state.


                        StatusCondition

object

StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

Properties

`message`	string	Human-friendly representation of the condition
`code`	string Allowed values: - `UNKNOWN` - `GCE_STOCKOUT` - `GKE_SERVICE_ACCOUNT_DELETED` - `GCE_QUOTA_EXCEEDED` - `SET_BY_OPERATOR` - `CLOUD_KMS_KEY_ERROR`	Machine-friendly representation of the condition


                        name

string

The server-assigned ID for the operation.


                        location

string

[Output only] The name of the Google Compute Engine zone or region in which the cluster resides.


                        endTime

string

[Output only] The time the operation completed, in RFC3339 text format.


                        detail

string

Detailed operation progress, if available.


                        clusterConditions

array [StatusCondition]

Which conditions caused the current cluster state.


                        StatusCondition

object

StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

Properties

`message`	string	Human-friendly representation of the condition
`code`	string Allowed values: - `UNKNOWN` - `GCE_STOCKOUT` - `GKE_SERVICE_ACCOUNT_DELETED` - `GCE_QUOTA_EXCEEDED` - `SET_BY_OPERATOR` - `CLOUD_KMS_KEY_ERROR`	Machine-friendly representation of the condition

POST

/v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:startIpRotation

Starts master IP rotation.

Request

Path

Name	Data Type	Description
`clusterId`	string	Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.
`zone`	string	Required. 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.
`projectId`	string	Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

Body

Name Data Type Description

StartIPRotationRequest


                        StartIPRotationRequest

object

StartIPRotationRequest creates a new IP for the cluster and then performs a node upgrade on each node pool to point to the new IP.

Properties

`zone`	string	Required. 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.
`rotateCredentials`	boolean	Whether to rotate credentials during IP rotation.
`projectId`	string	Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.
`name`	string	The name (project, location, cluster id) of the cluster to start IP rotation. Specified in the format 'projects//locations//clusters/*'.
`clusterId`	string	Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.

Responses

200Successful response

Body

Name Data Type Description

Operation


                        Operation

object

This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

Properties


                        zone

string

The name of the Google Compute Engine zone in which the operation is taking place. This field is deprecated, use location instead.


                        targetLink

string

Server-defined URL for the target of the operation.


                        statusMessage

string

If an error has occurred, a textual description of the error.


                        status

string
Allowed values:
- STATUS_UNSPECIFIED
- PENDING
- RUNNING
- DONE
- ABORTING

The current status of the operation.


                        startTime

string

[Output only] The time the operation started, in RFC3339 text format.


                        selfLink

string

Server-defined URL for the resource.


                        operationType

string
Allowed values:
- TYPE_UNSPECIFIED
- CREATE_CLUSTER
- DELETE_CLUSTER
- UPGRADE_MASTER
- UPGRADE_NODES
- REPAIR_CLUSTER
- UPDATE_CLUSTER
- CREATE_NODE_POOL
- DELETE_NODE_POOL
- SET_NODE_POOL_MANAGEMENT
- AUTO_REPAIR_NODES
- AUTO_UPGRADE_NODES
- SET_LABELS
- SET_MASTER_AUTH
- SET_NODE_POOL_SIZE
- SET_NETWORK_POLICY
- SET_MAINTENANCE_POLICY

The operation type.


                        nodepoolConditions

array [StatusCondition]

Which conditions caused the current node pool state.


                        StatusCondition

object

StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

Properties

`message`	string	Human-friendly representation of the condition
`code`	string Allowed values: - `UNKNOWN` - `GCE_STOCKOUT` - `GKE_SERVICE_ACCOUNT_DELETED` - `GCE_QUOTA_EXCEEDED` - `SET_BY_OPERATOR` - `CLOUD_KMS_KEY_ERROR`	Machine-friendly representation of the condition


                        name

string

The server-assigned ID for the operation.


                        location

string

[Output only] The name of the Google Compute Engine zone or region in which the cluster resides.


                        endTime

string

[Output only] The time the operation completed, in RFC3339 text format.


                        detail

string

Detailed operation progress, if available.


                        clusterConditions

array [StatusCondition]

Which conditions caused the current cluster state.


                        StatusCondition

object

StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

Properties

`message`	string	Human-friendly representation of the condition
`code`	string Allowed values: - `UNKNOWN` - `GCE_STOCKOUT` - `GKE_SERVICE_ACCOUNT_DELETED` - `GCE_QUOTA_EXCEEDED` - `SET_BY_OPERATOR` - `CLOUD_KMS_KEY_ERROR`	Machine-friendly representation of the condition

DELETE

/v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}

Deletes the cluster, including the Kubernetes endpoint and all worker nodes.

Firewalls and routes that were configured during cluster creation are also deleted.

Other Google Compute Engine resources that might be in use by the cluster, such as load balancer resources, are not deleted if they weren't present when the cluster was initially created.

Request

Path

Name	Data Type	Description
`clusterId`	string	Required. Deprecated. The name of the cluster to delete. This field has been deprecated and replaced by the name field.
`zone`	string	Required. 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.
`projectId`	string	Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

Query

Name	Data Type	Description
`name`	string	The name (project, location, cluster) of the cluster to delete. Specified in the format 'projects//locations//clusters/*'.

Responses

200Successful response

Body

Name Data Type Description

Operation


                        Operation

object

This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

Properties


                        zone

string

The name of the Google Compute Engine zone in which the operation is taking place. This field is deprecated, use location instead.


                        targetLink

string

Server-defined URL for the target of the operation.


                        statusMessage

string

If an error has occurred, a textual description of the error.


                        status

string
Allowed values:
- STATUS_UNSPECIFIED
- PENDING
- RUNNING
- DONE
- ABORTING

The current status of the operation.


                        startTime

string

[Output only] The time the operation started, in RFC3339 text format.


                        selfLink

string

Server-defined URL for the resource.


                        operationType

string
Allowed values:
- TYPE_UNSPECIFIED
- CREATE_CLUSTER
- DELETE_CLUSTER
- UPGRADE_MASTER
- UPGRADE_NODES
- REPAIR_CLUSTER
- UPDATE_CLUSTER
- CREATE_NODE_POOL
- DELETE_NODE_POOL
- SET_NODE_POOL_MANAGEMENT
- AUTO_REPAIR_NODES
- AUTO_UPGRADE_NODES
- SET_LABELS
- SET_MASTER_AUTH
- SET_NODE_POOL_SIZE
- SET_NETWORK_POLICY
- SET_MAINTENANCE_POLICY

The operation type.


                        nodepoolConditions

array [StatusCondition]

Which conditions caused the current node pool state.


                        StatusCondition

object

StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

Properties

`message`	string	Human-friendly representation of the condition
`code`	string Allowed values: - `UNKNOWN` - `GCE_STOCKOUT` - `GKE_SERVICE_ACCOUNT_DELETED` - `GCE_QUOTA_EXCEEDED` - `SET_BY_OPERATOR` - `CLOUD_KMS_KEY_ERROR`	Machine-friendly representation of the condition


                        name

string

The server-assigned ID for the operation.


                        location

string

[Output only] The name of the Google Compute Engine zone or region in which the cluster resides.


                        endTime

string

[Output only] The time the operation completed, in RFC3339 text format.


                        detail

string

Detailed operation progress, if available.


                        clusterConditions

array [StatusCondition]

Which conditions caused the current cluster state.


                        StatusCondition

object

StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

Properties

`message`	string	Human-friendly representation of the condition
`code`	string Allowed values: - `UNKNOWN` - `GCE_STOCKOUT` - `GKE_SERVICE_ACCOUNT_DELETED` - `GCE_QUOTA_EXCEEDED` - `SET_BY_OPERATOR` - `CLOUD_KMS_KEY_ERROR`	Machine-friendly representation of the condition

GET

/v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}

Gets the details of a specific cluster.

Request

Path

Name	Data Type	Description
`clusterId`	string	Required. Deprecated. The name of the cluster to retrieve. This field has been deprecated and replaced by the name field.
`zone`	string	Required. 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.
`projectId`	string	Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

Query

Name	Data Type	Description
`name`	string	The name (project, location, cluster) of the cluster to retrieve. Specified in the format 'projects//locations//clusters/*'.

Responses

200Successful response

Body

Name Data Type Description

Cluster


                        Cluster

object

A Google Kubernetes Engine cluster.

Properties


                        zone

string

[Output only] The name of the Google Compute Engine zone in which the cluster resides. This field is deprecated, use location instead.


                        verticalPodAutoscaling

VerticalPodAutoscaling

Cluster-level Vertical Pod Autoscaling configuration.


                        VerticalPodAutoscaling

object

VerticalPodAutoscaling contains global, per-cluster information required by Vertical Pod Autoscaler to automatically adjust the resources of pods controlled by it.

Properties


                        enabled

boolean

Enables vertical pod autoscaling.


                        tpuIpv4CidrBlock

string

[Output only] The IP address range of the Cloud TPUs in this cluster, in CIDR notation (e.g. 1.2.3.4/29).


                        subnetwork

string

The name of the Google Compute Engine subnetwork to which the cluster is connected.


                        statusMessage

string

[Output only] Additional information about the current status of this cluster, if available.


                        status

string
Allowed values:
- STATUS_UNSPECIFIED
- PROVISIONING
- RUNNING
- RECONCILING
- STOPPING
- ERROR
- DEGRADED

[Output only] The current status of this cluster.


                        servicesIpv4Cidr

string

[Output only] The IP address range of the Kubernetes services in this cluster, in CIDR notation (e.g. 1.2.3.4/29). Service addresses are typically put in the last /16 from the container CIDR.


                        selfLink

string

[Output only] Server-defined URL for the resource.


                        resourceUsageExportConfig

ResourceUsageExportConfig

Configuration for exporting resource usages. Resource usage export is disabled when this config is unspecified.


                        ResourceUsageExportConfig

object

Configuration for exporting cluster resource usages.

Properties

`enableNetworkEgressMetering`	boolean	Whether to enable network egress metering for this cluster. If enabled, a daemonset will be created in the cluster to meter network egress traffic.
`consumptionMeteringConfig`	ConsumptionMeteringConfig	Configuration to enable resource consumption metering.
`bigqueryDestination`	BigQueryDestination	Configuration to use BigQuery as usage export destination.


                        resourceLabels

object

The resource labels for the cluster to use to annotate any related Google Compute Engine resources.


                        privateClusterConfig

PrivateClusterConfig

Configuration for private cluster.


                        PrivateClusterConfig

object

Configuration options for private clusters.

Properties

`publicEndpoint`	string	Output only. The external IP address of this cluster's master endpoint.
`privateEndpoint`	string	Output only. The internal IP address of this cluster's master endpoint.
`masterIpv4CidrBlock`	string	The IP range in CIDR notation to use for the hosted master network. This range will be used for assigning internal IP addresses to the master or set of masters, as well as the ILB VIP. This range must not overlap with any other ranges in use within the cluster's network.
`enablePrivateNodes`	boolean	Whether nodes have internal IP addresses only. If enabled, all nodes are given only RFC 1918 private addresses and communicate with the master via private networking.
`enablePrivateEndpoint`	boolean	Whether the master's internal IP address is used as the cluster endpoint.


                        nodePools

array [NodePool]

The node pools associated with this cluster. This field should not be set if "node_config" or "initial_node_count" are specified.


                        NodePool

object

NodePool contains the name and configuration for a cluster's node pool. Node pools are a set of nodes (i.e. VM's), with a common configuration and specification, under the control of the cluster master. They may have a set of Kubernetes labels applied to them, which may be used to reference them during pod scheduling. They may also be resized up or down, to accommodate the workload.

Properties

`version`	string	The version of the Kubernetes of this node.
`statusMessage`	string	[Output only] Additional information about the current status of this node pool instance, if available.
`status`	string Allowed values: - `STATUS_UNSPECIFIED` - `PROVISIONING` - `RUNNING` - `RUNNING_WITH_ERROR` - `RECONCILING` - `STOPPING` - `ERROR`	[Output only] The status of the nodes in this pool instance.
`selfLink`	string	[Output only] Server-defined URL for the resource.
`podIpv4CidrSize`	integer	[Output only] The pod CIDR block size per node in this node pool.
`name`	string	The name of the node pool.
`maxPodsConstraint`	MaxPodsConstraint	The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool.
`management`	NodeManagement	NodeManagement configuration for this NodePool.
`instanceGroupUrls`	array [string]	[Output only] The resource URLs of the managed instance groups associated with this node pool.
`initialNodeCount`	integer	The initial node count for the pool. You must ensure that your Compute Engine resource quota is sufficient for this number of instances. You must also have available firewall and routes quota.
`config`	NodeConfig	The node configuration of the pool.
`conditions`	array [StatusCondition]	Which conditions caused the current node pool state.
`autoscaling`	NodePoolAutoscaling	Autoscaler configuration for this NodePool. Autoscaler is enabled only if a valid configuration is present.


                        nodeIpv4CidrSize

integer

[Output only] The size of the address space on each node for hosting containers. This is provisioned from within the container_ipv4_cidr range. This field will only be set when cluster is in route-based network mode.


                        nodeConfig

NodeConfig

Parameters used in creating the cluster's nodes. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "initial_node_count") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. For responses, this field will be populated with the node configuration of the first node pool. (For configuration of each node pool, see node_pool.config)

If unspecified, the defaults are used. This field is deprecated, use node_pool.config instead.


                        NodeConfig

object

Parameters that describe the nodes in a cluster.

Properties

`taints`	array [NodeTaint]	List of kubernetes taints to be applied to each node. For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/
`tags`	array [string]	The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster or node pool creation. Each tag within the list must comply with RFC1035.
`shieldedInstanceConfig`	ShieldedInstanceConfig	Shielded Instance options.
`serviceAccount`	string	The Google Cloud Platform Service Account to be used by the node VMs. If no Service Account is specified, the "default" service account is used.
`preemptible`	boolean	Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances.
`oauthScopes`	array [string]	The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with gcr.io (the Google Container Registry). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.
`minCpuPlatform`	string	Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read how to specify min CPU platform
`metadata`	object	The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: "cluster-location" "cluster-name" "cluster-uid" "configure-sh" "containerd-configure-sh" "enable-os-login" "gci-update-strategy" "gci-ensure-gke-docker" "instance-template" "kube-env" "startup-script" "user-data" "disable-address-manager" "windows-startup-script-ps1" "common-psm1" "k8s-node-setup-psm1" "install-ssh-psm1" "user-profile-psm1" "serial-port-logging-enable" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB.
`machineType`	string	The name of a Google Compute Engine machine type (e.g. `n1-standard-1`). If unspecified, the default machine type is `n1-standard-1`.
`localSsdCount`	integer	The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information.
`labels`	object	The map of Kubernetes labels (key/value pairs) to be applied to each node. These will added in addition to any default label(s) that Kubernetes may apply to the node. In case of conflict in label keys, the applied set may differ depending on the Kubernetes version -- it's best to assume the behavior is undefined and conflicts should be avoided. For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/
`imageType`	string	The image type to use for this node. Note that for a given image type, the latest version of it will be used.
`diskType`	string	Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd') If unspecified, the default disk type is 'pd-standard'
`diskSizeGb`	integer	Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB.
`accelerators`	array [AcceleratorConfig]	A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs.


                        networkPolicy

NetworkPolicy

Configuration options for the NetworkPolicy feature.


                        NetworkPolicy

object

Configuration options for the NetworkPolicy feature. https://kubernetes.io/docs/concepts/services-networking/networkpolicies/

Properties

`provider`	string Allowed values: - `PROVIDER_UNSPECIFIED` - `CALICO`	The selected network policy provider.
`enabled`	boolean	Whether network policy is enabled on the cluster.


                        networkConfig

NetworkConfig

Configuration for cluster networking.


                        NetworkConfig

object

NetworkConfig reports the relative names of network & subnetwork.

Properties

`subnetwork`	string	Output only. The relative name of the Google Compute Engine subnetwork to which the cluster is connected. Example: projects/my-project/regions/us-central1/subnetworks/my-subnet
`network`	string	Output only. The relative name of the Google Compute Engine network(/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network
`enableIntraNodeVisibility`	boolean	Whether Intra-node visibility is enabled for this cluster. This makes same node pod to pod traffic visible for VPC network.


                        network

string

The name of the Google Compute Engine network to which the cluster is connected. If left unspecified, the default network will be used.


                        name

string

The name of this cluster. The name must be unique within this project and location (e.g. zone or region), and can be up to 40 characters with the following restrictions:

Lowercase letters, numbers, and hyphens only.
Must start with a letter.
Must end with a number or a letter.


                        monitoringService

string

The monitoring service the cluster should use to write metrics. Currently available options:

monitoring.googleapis.com - the Google Cloud Monitoring service.
none - no metrics will be exported from the cluster.
if left as an empty string, monitoring.googleapis.com will be used.


                        masterAuthorizedNetworksConfig

MasterAuthorizedNetworksConfig

The configuration options for master authorized networks feature.


                        MasterAuthorizedNetworksConfig

object

Configuration options for the master authorized networks feature. Enabled master authorized networks will disallow all external traffic to access Kubernetes master through HTTPS except traffic from the given CIDR blocks, Google Compute Engine Public IPs and Google Prod IPs.

Properties

`enabled`	boolean	Whether or not master authorized networks is enabled.
`cidrBlocks`	array [CidrBlock]	cidr_blocks define up to 50 external networks that could access Kubernetes master through HTTPS.


                        masterAuth

MasterAuth

The authentication information for accessing the master endpoint. If unspecified, the defaults are used: For clusters before v1.12, if master_auth is unspecified, username will be set to "admin", a random password will be generated, and a client certificate will be issued.


                        MasterAuth

object

The authentication information for accessing the master endpoint. Authentication can be done using HTTP basic auth or using client certificates.

Properties

`username`	string	The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string).
`password`	string	The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty.
`clusterCaCertificate`	string	[Output only] Base64-encoded public certificate that is the root of trust for the cluster.
`clientKey`	string	[Output only] Base64-encoded private key used by clients to authenticate to the cluster endpoint.
`clientCertificateConfig`	ClientCertificateConfig	Configuration for client certificate authentication on the cluster. For clusters before v1.12, if no configuration is specified, a client certificate is issued.
`clientCertificate`	string	[Output only] Base64-encoded public certificate used by clients to authenticate to the cluster endpoint.


                        maintenancePolicy

MaintenancePolicy

Configure the maintenance policy for this cluster.


                        MaintenancePolicy

object

MaintenancePolicy defines the maintenance policy to be used for the cluster.

Properties

`window`	MaintenanceWindow	Specifies the maintenance window in which maintenance may be performed.
`resourceVersion`	string	A hash identifying the version of this policy, so that updates to fields of the policy won't accidentally undo intermediate changes (and so that users of the API unaware of some fields won't accidentally remove other fields). Make a `get()` request to the cluster to get the current resource version and include it with requests to set the policy.


                        loggingService

string

The logging service the cluster should use to write logs. Currently available options:

"logging.googleapis.com/kubernetes" - the Google Cloud Logging service with Kubernetes-native resource model
logging.googleapis.com - the Google Cloud Logging service.
none - no logs will be exported from the cluster.
if left as an empty string,logging.googleapis.com will be used.


                        locations

array [string]

The list of Google Compute Engine zones in which the cluster's nodes should be located.


                        location

string

[Output only] The name of the Google Compute Engine zone or region in which the cluster resides.


                        legacyAbac

LegacyAbac

Configuration for the legacy ABAC authorization mode.


                        LegacyAbac

object

Configuration for the legacy Attribute Based Access Control authorization mode.

Properties


                        enabled

boolean

Whether the ABAC authorizer is enabled for this cluster. When enabled, identities in the system, including service accounts, nodes, and controllers, will have statically granted permissions beyond those provided by the RBAC configuration or IAM.


                        labelFingerprint

string

The fingerprint of the set of labels for this cluster.


                        ipAllocationPolicy

IPAllocationPolicy

Configuration for cluster IP allocation.


                        IPAllocationPolicy

object

Configuration for controlling how IPs are allocated in the cluster.

Properties

`useIpAliases`	boolean	Whether alias IPs will be used for pod IPs in the cluster.
`tpuIpv4CidrBlock`	string	The IP address range of the Cloud TPUs in this cluster. If unspecified, a range will be automatically chosen with the default size. This field is only applicable when `use_ip_aliases` is true. If unspecified, the range will use the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a CIDR notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use.
`subnetworkName`	string	A custom subnetwork name to be used if `create_subnetwork` is true. If this field is empty, then an automatic name will be chosen for the new subnetwork.
`servicesSecondaryRangeName`	string	The name of the secondary range to be used as for the services CIDR block. The secondary range will be used for service ClusterIPs. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases is true and create_subnetwork is false.
`servicesIpv4CidrBlock`	string	The IP address range of the services IPs in this cluster. If blank, a range will be automatically chosen with the default size. This field is only applicable when `use_ip_aliases` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a CIDR notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use.
`servicesIpv4Cidr`	string	This field is deprecated, use services_ipv4_cidr_block.
`nodeIpv4CidrBlock`	string	The IP address range of the instance IPs in this cluster. This is applicable only if `create_subnetwork` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a CIDR notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use.
`nodeIpv4Cidr`	string	This field is deprecated, use node_ipv4_cidr_block.
`createSubnetwork`	boolean	Whether a new subnetwork will be created automatically for the cluster. This field is only applicable when `use_ip_aliases` is true.
`clusterSecondaryRangeName`	string	The name of the secondary range to be used for the cluster CIDR block. The secondary range will be used for pod IP addresses. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases is true and create_subnetwork is false.
`clusterIpv4CidrBlock`	string	The IP address range for the cluster pod IPs. If this field is set, then `cluster.cluster_ipv4_cidr` must be left blank. This field is only applicable when `use_ip_aliases` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a CIDR notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use.
`clusterIpv4Cidr`	string	This field is deprecated, use cluster_ipv4_cidr_block.


                        instanceGroupUrls

array [string]

Deprecated. Use node_pools.instance_group_urls.


                        initialNodeCount

integer

The number of nodes to create in this cluster. You must ensure that your Compute Engine resource quota is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time.

This field is deprecated, use node_pool.initial_node_count instead.


                        initialClusterVersion

string

The initial Kubernetes version for this cluster. Valid versions are those found in validMasterVersions returned by getServerConfig. The version can be upgraded over time; such upgrades are reflected in currentMasterVersion and currentNodeVersion.

Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior:

"latest": picks the highest valid Kubernetes version
"1.X": picks the highest valid patch+gke.N patch in the 1.X version
"1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version
"1.X.Y-gke.N": picks an explicit Kubernetes version
"","-": picks the default Kubernetes version


                        expireTime

string

[Output only] The time the cluster will be automatically deleted in RFC3339 text format.


                        endpoint

string

[Output only] The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at https://username:password@endpoint/.

See the masterAuth property of this resource for username and password information.


                        enableTpu

boolean

Enable the ability to use Cloud TPUs in this cluster.


                        enableKubernetesAlpha

boolean

Kubernetes alpha features are enabled on this cluster. This includes alpha API groups (e.g. v1alpha1) and features that may not be production ready in the kubernetes version of the master and nodes. The cluster has no SLA for uptime and master/node upgrades are disabled. Alpha enabled clusters are automatically deleted thirty days after creation.


                        description

string

An optional description of this cluster.


                        defaultMaxPodsConstraint

MaxPodsConstraint

The default constraint on the maximum number of pods that can be run simultaneously on a node in the node pool of this cluster. Only honored if cluster created with IP Alias support.


                        MaxPodsConstraint

object

Constraints applied to pods.

Properties


                        maxPodsPerNode

string

Constraint enforced on the max num of pods per node.


                        databaseEncryption

DatabaseEncryption

Configuration of etcd encryption.


                        DatabaseEncryption

object

Configuration of etcd encryption.

Properties

`state`	string Allowed values: - `UNKNOWN` - `ENCRYPTED` - `DECRYPTED`	Denotes the state of etcd encryption.
`keyName`	string	Name of CloudKMS key to use for the encryption of secrets in etcd. Ex. projects/my-project/locations/global/keyRings/my-ring/cryptoKeys/my-key


                        currentNodeVersion

string

[Output only] Deprecated, use NodePools.version instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes.


                        currentNodeCount

integer

[Output only] The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information.


                        currentMasterVersion

string

[Output only] The current software version of the master endpoint.


                        createTime

string

[Output only] The time the cluster was created, in RFC3339 text format.


                        conditions

array [StatusCondition]

Which conditions caused the current cluster state.


                        StatusCondition

object

StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

Properties

`message`	string	Human-friendly representation of the condition
`code`	string Allowed values: - `UNKNOWN` - `GCE_STOCKOUT` - `GKE_SERVICE_ACCOUNT_DELETED` - `GCE_QUOTA_EXCEEDED` - `SET_BY_OPERATOR` - `CLOUD_KMS_KEY_ERROR`	Machine-friendly representation of the condition


                        clusterIpv4Cidr

string

The IP address range of the container pods in this cluster, in CIDR notation (e.g. 10.96.0.0/14). Leave blank to have one automatically chosen or specify a /14 block in 10.0.0.0/8.


                        binaryAuthorization

BinaryAuthorization

Configuration for Binary Authorization.


                        BinaryAuthorization

object

Configuration for Binary Authorization.

Properties


                        enabled

boolean

Enable Binary Authorization for this cluster. If enabled, all container images will be validated by Binary Authorization.


                        autoscaling

ClusterAutoscaling

Cluster-level autoscaling configuration.


                        ClusterAutoscaling

object

ClusterAutoscaling contains global, per-cluster information required by Cluster Autoscaler to automatically adjust the size of the cluster and create/delete node pools based on the current needs.

Properties

`resourceLimits`	array [ResourceLimit]	Contains global constraints regarding minimum and maximum amount of resources in the cluster.
`enableNodeAutoprovisioning`	boolean	Enables automatic node pool creation and deletion.
`autoprovisioningNodePoolDefaults`	AutoprovisioningNodePoolDefaults	AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP.
`autoprovisioningLocations`	array [string]	The list of Google Compute Engine zones in which the NodePool's nodes can be created by NAP.


                        authenticatorGroupsConfig

AuthenticatorGroupsConfig

Configuration controlling RBAC group membership information.


                        AuthenticatorGroupsConfig

object

Configuration for returning group information from authenticators.

Properties

`securityGroup`	string	The name of the security group-of-groups to be used. Only relevant if enabled = true.
`enabled`	boolean	Whether this cluster should return group membership lookups during authentication using a group of security groups.


                        addonsConfig

AddonsConfig

Configurations for the various addons available to run in the cluster.


                        AddonsConfig

object

Configuration for the addons that can be automatically spun up in the cluster, enabling additional functionality.

Properties

`networkPolicyConfig`	NetworkPolicyConfig	Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes.
`kubernetesDashboard`	KubernetesDashboard	Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards
`httpLoadBalancing`	HttpLoadBalancing	Configuration for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster.
`horizontalPodAutoscaling`	HorizontalPodAutoscaling	Configuration for the horizontal pod autoscaling feature, which increases or decreases the number of replica pods a replication controller has based on the resource usage of the existing pods.
`cloudRunConfig`	CloudRunConfig	Configuration for the Cloud Run addon, which allows the user to use a managed Knative service.

PUT

/v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}

Updates the settings of a specific cluster.

Request

Path

Name	Data Type	Description
`clusterId`	string	Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.
`zone`	string	Required. 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.
`projectId`	string	Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

Body

Name Data Type Description

UpdateClusterRequest


                        UpdateClusterRequest

object

UpdateClusterRequest updates the settings of a cluster.

Properties


                        zone

string

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


                        update

ClusterUpdate

Required. A description of the update.


                        ClusterUpdate

object

ClusterUpdate describes an update to the cluster. Exactly one update can be applied to a cluster with each request, so at most one field can be provided.

Properties

`desiredVerticalPodAutoscaling`	VerticalPodAutoscaling	Cluster-level Vertical Pod Autoscaling configuration.
`desiredResourceUsageExportConfig`	ResourceUsageExportConfig	The desired configuration for exporting resource usage.
`desiredNodeVersion`	string	The Kubernetes version to change the nodes to (typically an upgrade). Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: "latest": picks the highest valid Kubernetes version "1.X": picks the highest valid patch+gke.N patch in the 1.X version "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version "1.X.Y-gke.N": picks an explicit Kubernetes version "-": picks the Kubernetes master version
`desiredNodePoolId`	string	The node pool to be upgraded. This field is mandatory if "desired_node_version", "desired_image_family" or "desired_node_pool_autoscaling" is specified and there is more than one node pool on the cluster.
`desiredNodePoolAutoscaling`	NodePoolAutoscaling	Autoscaler configuration for the node pool specified in desired_node_pool_id. If there is only one pool in the cluster and desired_node_pool_id is not provided then the change applies to that single node pool.
`desiredMonitoringService`	string	The monitoring service the cluster should use to write metrics. Currently available options: "monitoring.googleapis.com/kubernetes" - the Google Cloud Monitoring service with Kubernetes-native resource model "monitoring.googleapis.com" - the Google Cloud Monitoring service "none" - no metrics will be exported from the cluster
`desiredMasterVersion`	string	The Kubernetes version to change the master to. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: "latest": picks the highest valid Kubernetes version "1.X": picks the highest valid patch+gke.N patch in the 1.X version "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version "1.X.Y-gke.N": picks an explicit Kubernetes version "-": picks the default Kubernetes version
`desiredMasterAuthorizedNetworksConfig`	MasterAuthorizedNetworksConfig	The desired configuration options for master authorized networks feature.
`desiredLoggingService`	string	The logging service the cluster should use to write logs. Currently available options: "logging.googleapis.com/kubernetes" - the Google Cloud Logging service with Kubernetes-native resource model "logging.googleapis.com" - the Google Cloud Logging service "none" - no logs will be exported from the cluster
`desiredLocations`	array [string]	The desired list of Google Compute Engine zones in which the cluster's nodes should be located. Changing the locations a cluster is in will result in nodes being either created or removed from the cluster, depending on whether locations are being added or removed. This list must always include the cluster's primary zone.
`desiredIntraNodeVisibilityConfig`	IntraNodeVisibilityConfig	The desired config of Intra-node visibility.
`desiredImageType`	string	The desired image type for the node pool. NOTE: Set the "desired_node_pool" field as well.
`desiredDatabaseEncryption`	DatabaseEncryption	Configuration of etcd encryption.
`desiredClusterAutoscaling`	ClusterAutoscaling	Cluster-level autoscaling configuration.
`desiredBinaryAuthorization`	BinaryAuthorization	The desired configuration options for the Binary Authorization feature.
`desiredAddonsConfig`	AddonsConfig	Configurations for the various addons available to run in the cluster.


                        projectId

string

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


                        name

string

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


                        clusterId

string

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

Responses

200Successful response

Body

Name Data Type Description

Operation


                        Operation

object

This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

Properties


                        zone

string

The name of the Google Compute Engine zone in which the operation is taking place. This field is deprecated, use location instead.


                        targetLink

string

Server-defined URL for the target of the operation.


                        statusMessage

string

If an error has occurred, a textual description of the error.


                        status

string
Allowed values:
- STATUS_UNSPECIFIED
- PENDING
- RUNNING
- DONE
- ABORTING

The current status of the operation.


                        startTime

string

[Output only] The time the operation started, in RFC3339 text format.


                        selfLink

string

Server-defined URL for the resource.


                        operationType

string
Allowed values:
- TYPE_UNSPECIFIED
- CREATE_CLUSTER
- DELETE_CLUSTER
- UPGRADE_MASTER
- UPGRADE_NODES
- REPAIR_CLUSTER
- UPDATE_CLUSTER
- CREATE_NODE_POOL
- DELETE_NODE_POOL
- SET_NODE_POOL_MANAGEMENT
- AUTO_REPAIR_NODES
- AUTO_UPGRADE_NODES
- SET_LABELS
- SET_MASTER_AUTH
- SET_NODE_POOL_SIZE
- SET_NETWORK_POLICY
- SET_MAINTENANCE_POLICY

The operation type.


                        nodepoolConditions

array [StatusCondition]

Which conditions caused the current node pool state.


                        StatusCondition

object

StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

Properties

`message`	string	Human-friendly representation of the condition
`code`	string Allowed values: - `UNKNOWN` - `GCE_STOCKOUT` - `GKE_SERVICE_ACCOUNT_DELETED` - `GCE_QUOTA_EXCEEDED` - `SET_BY_OPERATOR` - `CLOUD_KMS_KEY_ERROR`	Machine-friendly representation of the condition


                        name

string

The server-assigned ID for the operation.


                        location

string

[Output only] The name of the Google Compute Engine zone or region in which the cluster resides.


                        endTime

string

[Output only] The time the operation completed, in RFC3339 text format.


                        detail

string

Detailed operation progress, if available.


                        clusterConditions

array [StatusCondition]

Which conditions caused the current cluster state.


                        StatusCondition

object

StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

Properties

`message`	string	Human-friendly representation of the condition
`code`	string Allowed values: - `UNKNOWN` - `GCE_STOCKOUT` - `GKE_SERVICE_ACCOUNT_DELETED` - `GCE_QUOTA_EXCEEDED` - `SET_BY_OPERATOR` - `CLOUD_KMS_KEY_ERROR`	Machine-friendly representation of the condition

GET

/v1/projects/{projectId}/zones/{zone}/clusters

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

Request

Path

Name	Data Type	Description
`zone`	string	Required. Deprecated. 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.
`projectId`	string	Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the parent field.

Query

Name	Data Type	Description
`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.

Responses

200Successful response

Body

Name Data Type Description

ListClustersResponse


                        ListClustersResponse

object

ListClustersResponse is the result of ListClustersRequest.

Properties


                        missingZones

array [string]

If any zones are listed here, the list of clusters returned may be missing those zones.


                        clusters

array [Cluster]

A list of clusters in the project in the specified zone, or across all ones.


                        Cluster

object

A Google Kubernetes Engine cluster.

Properties

`zone`	string	[Output only] The name of the Google Compute Engine zone in which the cluster resides. This field is deprecated, use location instead.
`verticalPodAutoscaling`	VerticalPodAutoscaling	Cluster-level Vertical Pod Autoscaling configuration.
`tpuIpv4CidrBlock`	string	[Output only] The IP address range of the Cloud TPUs in this cluster, in CIDR notation (e.g. `1.2.3.4/29`).
`subnetwork`	string	The name of the Google Compute Engine subnetwork to which the cluster is connected.
`statusMessage`	string	[Output only] Additional information about the current status of this cluster, if available.
`status`	string Allowed values: - `STATUS_UNSPECIFIED` - `PROVISIONING` - `RUNNING` - `RECONCILING` - `STOPPING` - `ERROR` - `DEGRADED`	[Output only] The current status of this cluster.
`servicesIpv4Cidr`	string	[Output only] The IP address range of the Kubernetes services in this cluster, in CIDR notation (e.g. `1.2.3.4/29`). Service addresses are typically put in the last `/16` from the container CIDR.
`selfLink`	string	[Output only] Server-defined URL for the resource.
`resourceUsageExportConfig`	ResourceUsageExportConfig	Configuration for exporting resource usages. Resource usage export is disabled when this config is unspecified.
`resourceLabels`	object	The resource labels for the cluster to use to annotate any related Google Compute Engine resources.
`privateClusterConfig`	PrivateClusterConfig	Configuration for private cluster.
`nodePools`	array [NodePool]	The node pools associated with this cluster. This field should not be set if "node_config" or "initial_node_count" are specified.
`nodeIpv4CidrSize`	integer	[Output only] The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. This field will only be set when cluster is in route-based network mode.
`nodeConfig`	NodeConfig	Parameters used in creating the cluster's nodes. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "initial_node_count") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. For responses, this field will be populated with the node configuration of the first node pool. (For configuration of each node pool, see `node_pool.config`) If unspecified, the defaults are used. This field is deprecated, use node_pool.config instead.
`networkPolicy`	NetworkPolicy	Configuration options for the NetworkPolicy feature.
`networkConfig`	NetworkConfig	Configuration for cluster networking.
`network`	string	The name of the Google Compute Engine network to which the cluster is connected. If left unspecified, the `default` network will be used.
`name`	string	The name of this cluster. The name must be unique within this project and location (e.g. zone or region), and can be up to 40 characters with the following restrictions: Lowercase letters, numbers, and hyphens only. Must start with a letter. Must end with a number or a letter.
`monitoringService`	string	The monitoring service the cluster should use to write metrics. Currently available options: `monitoring.googleapis.com` - the Google Cloud Monitoring service. `none` - no metrics will be exported from the cluster. if left as an empty string, `monitoring.googleapis.com` will be used.
`masterAuthorizedNetworksConfig`	MasterAuthorizedNetworksConfig	The configuration options for master authorized networks feature.
`masterAuth`	MasterAuth	The authentication information for accessing the master endpoint. If unspecified, the defaults are used: For clusters before v1.12, if master_auth is unspecified, `username` will be set to "admin", a random password will be generated, and a client certificate will be issued.
`maintenancePolicy`	MaintenancePolicy	Configure the maintenance policy for this cluster.
`loggingService`	string	The logging service the cluster should use to write logs. Currently available options: "logging.googleapis.com/kubernetes" - the Google Cloud Logging service with Kubernetes-native resource model `logging.googleapis.com` - the Google Cloud Logging service. `none` - no logs will be exported from the cluster. if left as an empty string,`logging.googleapis.com` will be used.
`locations`	array [string]	The list of Google Compute Engine zones in which the cluster's nodes should be located.
`location`	string	[Output only] The name of the Google Compute Engine zone or region in which the cluster resides.
`legacyAbac`	LegacyAbac	Configuration for the legacy ABAC authorization mode.
`labelFingerprint`	string	The fingerprint of the set of labels for this cluster.
`ipAllocationPolicy`	IPAllocationPolicy	Configuration for cluster IP allocation.
`instanceGroupUrls`	array [string]	Deprecated. Use node_pools.instance_group_urls.
`initialNodeCount`	integer	The number of nodes to create in this cluster. You must ensure that your Compute Engine resource quota is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. This field is deprecated, use node_pool.initial_node_count instead.
`initialClusterVersion`	string	The initial Kubernetes version for this cluster. Valid versions are those found in validMasterVersions returned by getServerConfig. The version can be upgraded over time; such upgrades are reflected in currentMasterVersion and currentNodeVersion. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: "latest": picks the highest valid Kubernetes version "1.X": picks the highest valid patch+gke.N patch in the 1.X version "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version "1.X.Y-gke.N": picks an explicit Kubernetes version "","-": picks the default Kubernetes version
`expireTime`	string	[Output only] The time the cluster will be automatically deleted in RFC3339 text format.
`endpoint`	string	[Output only] The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information.
`enableTpu`	boolean	Enable the ability to use Cloud TPUs in this cluster.
`enableKubernetesAlpha`	boolean	Kubernetes alpha features are enabled on this cluster. This includes alpha API groups (e.g. v1alpha1) and features that may not be production ready in the kubernetes version of the master and nodes. The cluster has no SLA for uptime and master/node upgrades are disabled. Alpha enabled clusters are automatically deleted thirty days after creation.
`description`	string	An optional description of this cluster.
`defaultMaxPodsConstraint`	MaxPodsConstraint	The default constraint on the maximum number of pods that can be run simultaneously on a node in the node pool of this cluster. Only honored if cluster created with IP Alias support.
`databaseEncryption`	DatabaseEncryption	Configuration of etcd encryption.
`currentNodeVersion`	string	[Output only] Deprecated, use NodePools.version instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes.
`currentNodeCount`	integer	[Output only] The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information.
`currentMasterVersion`	string	[Output only] The current software version of the master endpoint.
`createTime`	string	[Output only] The time the cluster was created, in RFC3339 text format.
`conditions`	array [StatusCondition]	Which conditions caused the current cluster state.
`clusterIpv4Cidr`	string	The IP address range of the container pods in this cluster, in CIDR notation (e.g. `10.96.0.0/14`). Leave blank to have one automatically chosen or specify a `/14` block in `10.0.0.0/8`.
`binaryAuthorization`	BinaryAuthorization	Configuration for Binary Authorization.
`autoscaling`	ClusterAutoscaling	Cluster-level autoscaling configuration.
`authenticatorGroupsConfig`	AuthenticatorGroupsConfig	Configuration controlling RBAC group membership information.
`addonsConfig`	AddonsConfig	Configurations for the various addons available to run in the cluster.

POST

/v1/projects/{projectId}/zones/{zone}/clusters

Creates a cluster, consisting of the specified number and type of Google Compute Engine instances.

By default, the cluster is created in the project's default network.

One firewall is added for the cluster. After cluster creation, the Kubelet creates routes for each node to allow the containers on that node to communicate with all other instances in the cluster.

Finally, an entry is added to the project's global metadata indicating which CIDR range the cluster is using.

Request

Path

Name	Data Type	Description
`zone`	string	Required. Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the parent field.
`projectId`	string	Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the parent field.

Body

Name Data Type Description

CreateClusterRequest


                        CreateClusterRequest

object

CreateClusterRequest creates a cluster.

Properties


                        zone

string

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


                        projectId

string

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


                        parent

string

The parent (project and location) where the cluster will be created. Specified in the format 'projects//locations/'.


                        cluster

Cluster

Required. A cluster resource


                        Cluster

object

A Google Kubernetes Engine cluster.

Properties

`zone`	string	[Output only] The name of the Google Compute Engine zone in which the cluster resides. This field is deprecated, use location instead.
`verticalPodAutoscaling`	VerticalPodAutoscaling	Cluster-level Vertical Pod Autoscaling configuration.
`tpuIpv4CidrBlock`	string	[Output only] The IP address range of the Cloud TPUs in this cluster, in CIDR notation (e.g. `1.2.3.4/29`).
`subnetwork`	string	The name of the Google Compute Engine subnetwork to which the cluster is connected.
`statusMessage`	string	[Output only] Additional information about the current status of this cluster, if available.
`status`	string Allowed values: - `STATUS_UNSPECIFIED` - `PROVISIONING` - `RUNNING` - `RECONCILING` - `STOPPING` - `ERROR` - `DEGRADED`	[Output only] The current status of this cluster.
`servicesIpv4Cidr`	string	[Output only] The IP address range of the Kubernetes services in this cluster, in CIDR notation (e.g. `1.2.3.4/29`). Service addresses are typically put in the last `/16` from the container CIDR.
`selfLink`	string	[Output only] Server-defined URL for the resource.
`resourceUsageExportConfig`	ResourceUsageExportConfig	Configuration for exporting resource usages. Resource usage export is disabled when this config is unspecified.
`resourceLabels`	object	The resource labels for the cluster to use to annotate any related Google Compute Engine resources.
`privateClusterConfig`	PrivateClusterConfig	Configuration for private cluster.
`nodePools`	array [NodePool]	The node pools associated with this cluster. This field should not be set if "node_config" or "initial_node_count" are specified.
`nodeIpv4CidrSize`	integer	[Output only] The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. This field will only be set when cluster is in route-based network mode.
`nodeConfig`	NodeConfig	Parameters used in creating the cluster's nodes. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "initial_node_count") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. For responses, this field will be populated with the node configuration of the first node pool. (For configuration of each node pool, see `node_pool.config`) If unspecified, the defaults are used. This field is deprecated, use node_pool.config instead.
`networkPolicy`	NetworkPolicy	Configuration options for the NetworkPolicy feature.
`networkConfig`	NetworkConfig	Configuration for cluster networking.
`network`	string	The name of the Google Compute Engine network to which the cluster is connected. If left unspecified, the `default` network will be used.
`name`	string	The name of this cluster. The name must be unique within this project and location (e.g. zone or region), and can be up to 40 characters with the following restrictions: Lowercase letters, numbers, and hyphens only. Must start with a letter. Must end with a number or a letter.
`monitoringService`	string	The monitoring service the cluster should use to write metrics. Currently available options: `monitoring.googleapis.com` - the Google Cloud Monitoring service. `none` - no metrics will be exported from the cluster. if left as an empty string, `monitoring.googleapis.com` will be used.
`masterAuthorizedNetworksConfig`	MasterAuthorizedNetworksConfig	The configuration options for master authorized networks feature.
`masterAuth`	MasterAuth	The authentication information for accessing the master endpoint. If unspecified, the defaults are used: For clusters before v1.12, if master_auth is unspecified, `username` will be set to "admin", a random password will be generated, and a client certificate will be issued.
`maintenancePolicy`	MaintenancePolicy	Configure the maintenance policy for this cluster.
`loggingService`	string	The logging service the cluster should use to write logs. Currently available options: "logging.googleapis.com/kubernetes" - the Google Cloud Logging service with Kubernetes-native resource model `logging.googleapis.com` - the Google Cloud Logging service. `none` - no logs will be exported from the cluster. if left as an empty string,`logging.googleapis.com` will be used.
`locations`	array [string]	The list of Google Compute Engine zones in which the cluster's nodes should be located.
`location`	string	[Output only] The name of the Google Compute Engine zone or region in which the cluster resides.
`legacyAbac`	LegacyAbac	Configuration for the legacy ABAC authorization mode.
`labelFingerprint`	string	The fingerprint of the set of labels for this cluster.
`ipAllocationPolicy`	IPAllocationPolicy	Configuration for cluster IP allocation.
`instanceGroupUrls`	array [string]	Deprecated. Use node_pools.instance_group_urls.
`initialNodeCount`	integer	The number of nodes to create in this cluster. You must ensure that your Compute Engine resource quota is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. This field is deprecated, use node_pool.initial_node_count instead.
`initialClusterVersion`	string	The initial Kubernetes version for this cluster. Valid versions are those found in validMasterVersions returned by getServerConfig. The version can be upgraded over time; such upgrades are reflected in currentMasterVersion and currentNodeVersion. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: "latest": picks the highest valid Kubernetes version "1.X": picks the highest valid patch+gke.N patch in the 1.X version "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version "1.X.Y-gke.N": picks an explicit Kubernetes version "","-": picks the default Kubernetes version
`expireTime`	string	[Output only] The time the cluster will be automatically deleted in RFC3339 text format.
`endpoint`	string	[Output only] The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information.
`enableTpu`	boolean	Enable the ability to use Cloud TPUs in this cluster.
`enableKubernetesAlpha`	boolean	Kubernetes alpha features are enabled on this cluster. This includes alpha API groups (e.g. v1alpha1) and features that may not be production ready in the kubernetes version of the master and nodes. The cluster has no SLA for uptime and master/node upgrades are disabled. Alpha enabled clusters are automatically deleted thirty days after creation.
`description`	string	An optional description of this cluster.
`defaultMaxPodsConstraint`	MaxPodsConstraint	The default constraint on the maximum number of pods that can be run simultaneously on a node in the node pool of this cluster. Only honored if cluster created with IP Alias support.
`databaseEncryption`	DatabaseEncryption	Configuration of etcd encryption.
`currentNodeVersion`	string	[Output only] Deprecated, use NodePools.version instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes.
`currentNodeCount`	integer	[Output only] The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information.
`currentMasterVersion`	string	[Output only] The current software version of the master endpoint.
`createTime`	string	[Output only] The time the cluster was created, in RFC3339 text format.
`conditions`	array [StatusCondition]	Which conditions caused the current cluster state.
`clusterIpv4Cidr`	string	The IP address range of the container pods in this cluster, in CIDR notation (e.g. `10.96.0.0/14`). Leave blank to have one automatically chosen or specify a `/14` block in `10.0.0.0/8`.
`binaryAuthorization`	BinaryAuthorization	Configuration for Binary Authorization.
`autoscaling`	ClusterAutoscaling	Cluster-level autoscaling configuration.
`authenticatorGroupsConfig`	AuthenticatorGroupsConfig	Configuration controlling RBAC group membership information.
`addonsConfig`	AddonsConfig	Configurations for the various addons available to run in the cluster.

Responses

200Successful response

Body

Name Data Type Description

Operation


                        Operation

object

This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

Properties


                        zone

string

The name of the Google Compute Engine zone in which the operation is taking place. This field is deprecated, use location instead.


                        targetLink

string

Server-defined URL for the target of the operation.


                        statusMessage

string

If an error has occurred, a textual description of the error.


                        status

string
Allowed values:
- STATUS_UNSPECIFIED
- PENDING
- RUNNING
- DONE
- ABORTING

The current status of the operation.


                        startTime

string

[Output only] The time the operation started, in RFC3339 text format.


                        selfLink

string

Server-defined URL for the resource.


                        operationType

string
Allowed values:
- TYPE_UNSPECIFIED
- CREATE_CLUSTER
- DELETE_CLUSTER
- UPGRADE_MASTER
- UPGRADE_NODES
- REPAIR_CLUSTER
- UPDATE_CLUSTER
- CREATE_NODE_POOL
- DELETE_NODE_POOL
- SET_NODE_POOL_MANAGEMENT
- AUTO_REPAIR_NODES
- AUTO_UPGRADE_NODES
- SET_LABELS
- SET_MASTER_AUTH
- SET_NODE_POOL_SIZE
- SET_NETWORK_POLICY
- SET_MAINTENANCE_POLICY

The operation type.


                        nodepoolConditions

array [StatusCondition]

Which conditions caused the current node pool state.


                        StatusCondition

object

StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

Properties

`message`	string	Human-friendly representation of the condition
`code`	string Allowed values: - `UNKNOWN` - `GCE_STOCKOUT` - `GKE_SERVICE_ACCOUNT_DELETED` - `GCE_QUOTA_EXCEEDED` - `SET_BY_OPERATOR` - `CLOUD_KMS_KEY_ERROR`	Machine-friendly representation of the condition


                        name

string

The server-assigned ID for the operation.


                        location

string

[Output only] The name of the Google Compute Engine zone or region in which the cluster resides.


                        endTime

string

[Output only] The time the operation completed, in RFC3339 text format.


                        detail

string

Detailed operation progress, if available.


                        clusterConditions

array [StatusCondition]

Which conditions caused the current cluster state.


                        StatusCondition

object

StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

Properties

`message`	string	Human-friendly representation of the condition
`code`	string Allowed values: - `UNKNOWN` - `GCE_STOCKOUT` - `GKE_SERVICE_ACCOUNT_DELETED` - `GCE_QUOTA_EXCEEDED` - `SET_BY_OPERATOR` - `CLOUD_KMS_KEY_ERROR`	Machine-friendly representation of the condition

POST

/v1/projects/{projectId}/zones/{zone}/operations/{operationId}:cancel

Cancels the specified operation.

Request

Path

Name	Data Type	Description
`operationId`	string	Required. Deprecated. The server-assigned `name` of the operation. This field has been deprecated and replaced by the name field.
`zone`	string	Required. Deprecated. The name of the Google Compute Engine zone in which the operation resides. This field has been deprecated and replaced by the name field.
`projectId`	string	Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

Body

Name Data Type Description

CancelOperationRequest


                        CancelOperationRequest

object

CancelOperationRequest cancels a single operation.

Properties

`zone`	string	Required. Deprecated. The name of the Google Compute Engine zone in which the operation resides. This field has been deprecated and replaced by the name field.
`projectId`	string	Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.
`operationId`	string	Required. Deprecated. The server-assigned `name` of the operation. This field has been deprecated and replaced by the name field.
`name`	string	The name (project, location, operation id) of the operation to cancel. Specified in the format 'projects//locations//operations/*'.

Responses

200Successful response

Body

Name Data Type Description

Empty


                        Empty

object

A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance:

service Foo {
  rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
}

The JSON representation for Empty is empty JSON object {}.

GET

/v1/projects/{projectId}/zones/{zone}/operations/{operationId}

Gets the specified operation.

Request

Path

Name	Data Type	Description
`operationId`	string	Required. Deprecated. The server-assigned `name` of the operation. This field has been deprecated and replaced by the name field.
`zone`	string	Required. 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.
`projectId`	string	Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

Query

Name	Data Type	Description
`name`	string	The name (project, location, operation id) of the operation to get. Specified in the format 'projects//locations//operations/*'.

Responses

200Successful response

Body

Name Data Type Description

Operation


                        Operation

object

This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

Properties


                        zone

string

The name of the Google Compute Engine zone in which the operation is taking place. This field is deprecated, use location instead.


                        targetLink

string

Server-defined URL for the target of the operation.


                        statusMessage

string

If an error has occurred, a textual description of the error.


                        status

string
Allowed values:
- STATUS_UNSPECIFIED
- PENDING
- RUNNING
- DONE
- ABORTING

The current status of the operation.


                        startTime

string

[Output only] The time the operation started, in RFC3339 text format.


                        selfLink

string

Server-defined URL for the resource.


                        operationType

string
Allowed values:
- TYPE_UNSPECIFIED
- CREATE_CLUSTER
- DELETE_CLUSTER
- UPGRADE_MASTER
- UPGRADE_NODES
- REPAIR_CLUSTER
- UPDATE_CLUSTER
- CREATE_NODE_POOL
- DELETE_NODE_POOL
- SET_NODE_POOL_MANAGEMENT
- AUTO_REPAIR_NODES
- AUTO_UPGRADE_NODES
- SET_LABELS
- SET_MASTER_AUTH
- SET_NODE_POOL_SIZE
- SET_NETWORK_POLICY
- SET_MAINTENANCE_POLICY

The operation type.


                        nodepoolConditions

array [StatusCondition]

Which conditions caused the current node pool state.


                        StatusCondition

object

StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

Properties

`message`	string	Human-friendly representation of the condition
`code`	string Allowed values: - `UNKNOWN` - `GCE_STOCKOUT` - `GKE_SERVICE_ACCOUNT_DELETED` - `GCE_QUOTA_EXCEEDED` - `SET_BY_OPERATOR` - `CLOUD_KMS_KEY_ERROR`	Machine-friendly representation of the condition


                        name

string

The server-assigned ID for the operation.


                        location

string

[Output only] The name of the Google Compute Engine zone or region in which the cluster resides.


                        endTime

string

[Output only] The time the operation completed, in RFC3339 text format.


                        detail

string

Detailed operation progress, if available.


                        clusterConditions

array [StatusCondition]

Which conditions caused the current cluster state.


                        StatusCondition

object

StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

Properties

`message`	string	Human-friendly representation of the condition
`code`	string Allowed values: - `UNKNOWN` - `GCE_STOCKOUT` - `GKE_SERVICE_ACCOUNT_DELETED` - `GCE_QUOTA_EXCEEDED` - `SET_BY_OPERATOR` - `CLOUD_KMS_KEY_ERROR`	Machine-friendly representation of the condition

GET

/v1/projects/{projectId}/zones/{zone}/operations

Lists all operations in a project in a specific zone or all zones.

Request

Path

Name	Data Type	Description
`zone`	string	Required. Deprecated. The name of the Google Compute Engine zone to return operations for, or `-` for all zones. This field has been deprecated and replaced by the parent field.
`projectId`	string	Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the parent field.

Query

Name	Data Type	Description
`parent`	string	The parent (project and location) where the operations will be listed. Specified in the format 'projects//locations/'. Location "-" matches all zones and all regions.

Responses

200Successful response

Body

Name Data Type Description

ListOperationsResponse


                        ListOperationsResponse

object

ListOperationsResponse is the result of ListOperationsRequest.

Properties


                        operations

array [Operation]

A list of operations in the project in the specified zone.


                        Operation

object

This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

Properties

`zone`	string	The name of the Google Compute Engine zone in which the operation is taking place. This field is deprecated, use location instead.
`targetLink`	string	Server-defined URL for the target of the operation.
`statusMessage`	string	If an error has occurred, a textual description of the error.
`status`	string Allowed values: - `STATUS_UNSPECIFIED` - `PENDING` - `RUNNING` - `DONE` - `ABORTING`	The current status of the operation.
`startTime`	string	[Output only] The time the operation started, in RFC3339 text format.
`selfLink`	string	Server-defined URL for the resource.
`operationType`	string Allowed values: - `TYPE_UNSPECIFIED` - `CREATE_CLUSTER` - `DELETE_CLUSTER` - `UPGRADE_MASTER` - `UPGRADE_NODES` - `REPAIR_CLUSTER` - `UPDATE_CLUSTER` - `CREATE_NODE_POOL` - `DELETE_NODE_POOL` - `SET_NODE_POOL_MANAGEMENT` - `AUTO_REPAIR_NODES` - `AUTO_UPGRADE_NODES` - `SET_LABELS` - `SET_MASTER_AUTH` - `SET_NODE_POOL_SIZE` - `SET_NETWORK_POLICY` - `SET_MAINTENANCE_POLICY`	The operation type.
`nodepoolConditions`	array [StatusCondition]	Which conditions caused the current node pool state.
`name`	string	The server-assigned ID for the operation.
`location`	string	[Output only] The name of the Google Compute Engine zone or region in which the cluster resides.
`endTime`	string	[Output only] The time the operation completed, in RFC3339 text format.
`detail`	string	Detailed operation progress, if available.
`clusterConditions`	array [StatusCondition]	Which conditions caused the current cluster state.


                        missingZones

array [string]

If any zones are listed here, the list of operations returned may be missing the operations from those zones.

GET

/v1/projects/{projectId}/zones/{zone}/serverconfig

Returns configuration info about the Google Kubernetes Engine service.

Request

Path

Name	Data Type	Description
`zone`	string	Required. Deprecated. The name of the Google Compute Engine zone to return operations for. This field has been deprecated and replaced by the name field.
`projectId`	string	Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

Query

Name	Data Type	Description
`name`	string	The name (project and location) of the server config to get, specified in the format 'projects//locations/'.

Responses

200Successful response

Body

Name Data Type Description

ServerConfig


                        ServerConfig

object

Kubernetes Engine service configuration.

Properties

`validNodeVersions`	array [string]	List of valid node upgrade target versions.
`validMasterVersions`	array [string]	List of valid master versions.
`validImageTypes`	array [string]	List of valid image types.
`defaultImageType`	string	Default image type.
`defaultClusterVersion`	string	Version of Kubernetes the service deploys by default.

GET

/v1/{name}/serverConfig

Returns configuration info about the Google Kubernetes Engine service.

Request

Path

Name	Data Type	Description
`name`	string	The name (project and location) of the server config to get, specified in the format 'projects//locations/'.

Query

Name	Data Type	Description
`zone`	string	Required. Deprecated. The name of the Google Compute Engine zone to return operations for. This field has been deprecated and replaced by the name field.
`projectId`	string	Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

Responses

200Successful response

Body

Name Data Type Description

ServerConfig


                        ServerConfig

object

Kubernetes Engine service configuration.

Properties

`validNodeVersions`	array [string]	List of valid node upgrade target versions.
`validMasterVersions`	array [string]	List of valid master versions.
`validImageTypes`	array [string]	List of valid image types.
`defaultImageType`	string	Default image type.
`defaultClusterVersion`	string	Version of Kubernetes the service deploys by default.

POST

/v1/{name}:cancel

Cancels the specified operation.

Request

Path

Name	Data Type	Description
`name`	string	The name (project, location, operation id) of the operation to cancel. Specified in the format 'projects//locations//operations/*'.

Body

Name Data Type Description

CancelOperationRequest


                        CancelOperationRequest

object

CancelOperationRequest cancels a single operation.

Properties

`zone`	string	Required. Deprecated. The name of the Google Compute Engine zone in which the operation resides. This field has been deprecated and replaced by the name field.
`projectId`	string	Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.
`operationId`	string	Required. Deprecated. The server-assigned `name` of the operation. This field has been deprecated and replaced by the name field.
`name`	string	The name (project, location, operation id) of the operation to cancel. Specified in the format 'projects//locations//operations/*'.

Responses

200Successful response

Body

Name Data Type Description

Empty


                        Empty

object

A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance:

service Foo {
  rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
}

The JSON representation for Empty is empty JSON object {}.

POST

/v1/{name}:completeIpRotation

Completes master IP rotation.

Request

Path

Name	Data Type	Description
`name`	string	The name (project, location, cluster id) of the cluster to complete IP rotation. Specified in the format 'projects//locations//clusters/*'.

Body

Name Data Type Description

CompleteIPRotationRequest


                        CompleteIPRotationRequest

object

CompleteIPRotationRequest moves the cluster master back into single-IP mode.

Properties

`zone`	string	Required. 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.
`projectId`	string	Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.
`name`	string	The name (project, location, cluster id) of the cluster to complete IP rotation. Specified in the format 'projects//locations//clusters/*'.
`clusterId`	string	Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.

Responses

200Successful response

Body

Name Data Type Description

Operation


                        Operation

object

This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

Properties


                        zone

string

The name of the Google Compute Engine zone in which the operation is taking place. This field is deprecated, use location instead.


                        targetLink

string

Server-defined URL for the target of the operation.


                        statusMessage

string

If an error has occurred, a textual description of the error.


                        status

string
Allowed values:
- STATUS_UNSPECIFIED
- PENDING
- RUNNING
- DONE
- ABORTING

The current status of the operation.


                        startTime

string

[Output only] The time the operation started, in RFC3339 text format.


                        selfLink

string

Server-defined URL for the resource.


                        operationType

string
Allowed values:
- TYPE_UNSPECIFIED
- CREATE_CLUSTER
- DELETE_CLUSTER
- UPGRADE_MASTER
- UPGRADE_NODES
- REPAIR_CLUSTER
- UPDATE_CLUSTER
- CREATE_NODE_POOL
- DELETE_NODE_POOL
- SET_NODE_POOL_MANAGEMENT
- AUTO_REPAIR_NODES
- AUTO_UPGRADE_NODES
- SET_LABELS
- SET_MASTER_AUTH
- SET_NODE_POOL_SIZE
- SET_NETWORK_POLICY
- SET_MAINTENANCE_POLICY

The operation type.


                        nodepoolConditions

array [StatusCondition]

Which conditions caused the current node pool state.


                        StatusCondition

object

StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

Properties

`message`	string	Human-friendly representation of the condition
`code`	string Allowed values: - `UNKNOWN` - `GCE_STOCKOUT` - `GKE_SERVICE_ACCOUNT_DELETED` - `GCE_QUOTA_EXCEEDED` - `SET_BY_OPERATOR` - `CLOUD_KMS_KEY_ERROR`	Machine-friendly representation of the condition


                        name

string

The server-assigned ID for the operation.


                        location

string

[Output only] The name of the Google Compute Engine zone or region in which the cluster resides.


                        endTime

string

[Output only] The time the operation completed, in RFC3339 text format.


                        detail

string

Detailed operation progress, if available.


                        clusterConditions

array [StatusCondition]

Which conditions caused the current cluster state.


                        StatusCondition

object

StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

Properties

`message`	string	Human-friendly representation of the condition
`code`	string Allowed values: - `UNKNOWN` - `GCE_STOCKOUT` - `GKE_SERVICE_ACCOUNT_DELETED` - `GCE_QUOTA_EXCEEDED` - `SET_BY_OPERATOR` - `CLOUD_KMS_KEY_ERROR`	Machine-friendly representation of the condition

POST

/v1/{name}:rollback

Rolls back a previously Aborted or Failed NodePool upgrade. This makes no changes if the last upgrade successfully completed.

Request

Path

Name	Data Type	Description
`name`	string	The name (project, location, cluster, node pool id) of the node poll to rollback upgrade. Specified in the format 'projects//locations//clusters//nodePools/'.

Body

Name Data Type Description

RollbackNodePoolUpgradeRequest


                        RollbackNodePoolUpgradeRequest

object

RollbackNodePoolUpgradeRequest rollbacks the previously Aborted or Failed NodePool upgrade. This will be an no-op if the last upgrade successfully completed.

Properties

`zone`	string	Required. 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.
`projectId`	string	Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.
`nodePoolId`	string	Required. Deprecated. The name of the node pool to rollback. This field has been deprecated and replaced by the name field.
`name`	string	The name (project, location, cluster, node pool id) of the node poll to rollback upgrade. Specified in the format 'projects//locations//clusters//nodePools/'.
`clusterId`	string	Required. Deprecated. The name of the cluster to rollback. This field has been deprecated and replaced by the name field.

Responses

200Successful response

Body

Name Data Type Description

Operation


                        Operation

object

This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

Properties


                        zone

string

The name of the Google Compute Engine zone in which the operation is taking place. This field is deprecated, use location instead.


                        targetLink

string

Server-defined URL for the target of the operation.


                        statusMessage

string

If an error has occurred, a textual description of the error.


                        status

string
Allowed values:
- STATUS_UNSPECIFIED
- PENDING
- RUNNING
- DONE
- ABORTING

The current status of the operation.


                        startTime

string

[Output only] The time the operation started, in RFC3339 text format.


                        selfLink

string

Server-defined URL for the resource.


                        operationType

string
Allowed values:
- TYPE_UNSPECIFIED
- CREATE_CLUSTER
- DELETE_CLUSTER
- UPGRADE_MASTER
- UPGRADE_NODES
- REPAIR_CLUSTER
- UPDATE_CLUSTER
- CREATE_NODE_POOL
- DELETE_NODE_POOL
- SET_NODE_POOL_MANAGEMENT
- AUTO_REPAIR_NODES
- AUTO_UPGRADE_NODES
- SET_LABELS
- SET_MASTER_AUTH
- SET_NODE_POOL_SIZE
- SET_NETWORK_POLICY
- SET_MAINTENANCE_POLICY

The operation type.


                        nodepoolConditions

array [StatusCondition]

Which conditions caused the current node pool state.


                        StatusCondition

object

StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

Properties

`message`	string	Human-friendly representation of the condition
`code`	string Allowed values: - `UNKNOWN` - `GCE_STOCKOUT` - `GKE_SERVICE_ACCOUNT_DELETED` - `GCE_QUOTA_EXCEEDED` - `SET_BY_OPERATOR` - `CLOUD_KMS_KEY_ERROR`	Machine-friendly representation of the condition


                        name

string

The server-assigned ID for the operation.


                        location

string

[Output only] The name of the Google Compute Engine zone or region in which the cluster resides.


                        endTime

string

[Output only] The time the operation completed, in RFC3339 text format.


                        detail

string

Detailed operation progress, if available.


                        clusterConditions

array [StatusCondition]

Which conditions caused the current cluster state.


                        StatusCondition

object

StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

Properties

`message`	string	Human-friendly representation of the condition
`code`	string Allowed values: - `UNKNOWN` - `GCE_STOCKOUT` - `GKE_SERVICE_ACCOUNT_DELETED` - `GCE_QUOTA_EXCEEDED` - `SET_BY_OPERATOR` - `CLOUD_KMS_KEY_ERROR`	Machine-friendly representation of the condition

POST

/v1/{name}:setAddons

Sets the addons for a specific cluster.

Request

Path

Name	Data Type	Description
`name`	string	The name (project, location, cluster) of the cluster to set addons. Specified in the format 'projects//locations//clusters/*'.

Body

Name Data Type Description

SetAddonsConfigRequest


                        SetAddonsConfigRequest

object

SetAddonsConfigRequest sets the addons associated with the cluster.

Properties


                        zone

string

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


                        projectId

string

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


                        name

string

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


                        clusterId

string

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


                        addonsConfig

AddonsConfig

Required. The desired configurations for the various addons available to run in the cluster.


                        AddonsConfig

object

Configuration for the addons that can be automatically spun up in the cluster, enabling additional functionality.

Properties

`networkPolicyConfig`	NetworkPolicyConfig	Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes.
`kubernetesDashboard`	KubernetesDashboard	Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards
`httpLoadBalancing`	HttpLoadBalancing	Configuration for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster.
`horizontalPodAutoscaling`	HorizontalPodAutoscaling	Configuration for the horizontal pod autoscaling feature, which increases or decreases the number of replica pods a replication controller has based on the resource usage of the existing pods.
`cloudRunConfig`	CloudRunConfig	Configuration for the Cloud Run addon, which allows the user to use a managed Knative service.

Responses

200Successful response

Body

Name Data Type Description

Operation


                        Operation

object

This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

Properties


                        zone

string

The name of the Google Compute Engine zone in which the operation is taking place. This field is deprecated, use location instead.


                        targetLink

string

Server-defined URL for the target of the operation.


                        statusMessage

string

If an error has occurred, a textual description of the error.


                        status

string
Allowed values:
- STATUS_UNSPECIFIED
- PENDING
- RUNNING
- DONE
- ABORTING

The current status of the operation.


                        startTime

string

[Output only] The time the operation started, in RFC3339 text format.


                        selfLink

string

Server-defined URL for the resource.


                        operationType

string
Allowed values:
- TYPE_UNSPECIFIED
- CREATE_CLUSTER
- DELETE_CLUSTER
- UPGRADE_MASTER
- UPGRADE_NODES
- REPAIR_CLUSTER
- UPDATE_CLUSTER
- CREATE_NODE_POOL
- DELETE_NODE_POOL
- SET_NODE_POOL_MANAGEMENT
- AUTO_REPAIR_NODES
- AUTO_UPGRADE_NODES
- SET_LABELS
- SET_MASTER_AUTH
- SET_NODE_POOL_SIZE
- SET_NETWORK_POLICY
- SET_MAINTENANCE_POLICY

The operation type.


                        nodepoolConditions

array [StatusCondition]

Which conditions caused the current node pool state.


                        StatusCondition

object

StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

Properties

`message`	string	Human-friendly representation of the condition
`code`	string Allowed values: - `UNKNOWN` - `GCE_STOCKOUT` - `GKE_SERVICE_ACCOUNT_DELETED` - `GCE_QUOTA_EXCEEDED` - `SET_BY_OPERATOR` - `CLOUD_KMS_KEY_ERROR`	Machine-friendly representation of the condition


                        name

string

The server-assigned ID for the operation.


                        location

string

[Output only] The name of the Google Compute Engine zone or region in which the cluster resides.


                        endTime

string

[Output only] The time the operation completed, in RFC3339 text format.


                        detail

string

Detailed operation progress, if available.


                        clusterConditions

array [StatusCondition]

Which conditions caused the current cluster state.


                        StatusCondition

object

StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

Properties

`message`	string	Human-friendly representation of the condition
`code`	string Allowed values: - `UNKNOWN` - `GCE_STOCKOUT` - `GKE_SERVICE_ACCOUNT_DELETED` - `GCE_QUOTA_EXCEEDED` - `SET_BY_OPERATOR` - `CLOUD_KMS_KEY_ERROR`	Machine-friendly representation of the condition

POST

/v1/{name}:setAutoscaling

Sets the autoscaling settings for the specified node pool.

Request

Path

Name	Data Type	Description
`name`	string	The name (project, location, cluster, node pool) of the node pool to set autoscaler settings. Specified in the format 'projects//locations//clusters//nodePools/'.

Body

Name Data Type Description

SetNodePoolAutoscalingRequest


                        SetNodePoolAutoscalingRequest

object

SetNodePoolAutoscalingRequest sets the autoscaler settings of a node pool.

Properties


                        zone

string

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


                        projectId

string

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


                        nodePoolId

string

Required. Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field.


                        name

string

The name (project, location, cluster, node pool) of the node pool to set autoscaler settings. Specified in the format 'projects//locations//clusters//nodePools/'.


                        clusterId

string

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


                        autoscaling

NodePoolAutoscaling

Required. Autoscaling configuration for the node pool.


                        NodePoolAutoscaling

object

NodePoolAutoscaling contains information required by cluster autoscaler to adjust the size of the node pool to the current cluster usage.

Properties

`minNodeCount`	integer	Minimum number of nodes in the NodePool. Must be >= 1 and <= max_node_count.
`maxNodeCount`	integer	Maximum number of nodes in the NodePool. Must be >= min_node_count. There has to enough quota to scale up the cluster.
`enabled`	boolean	Is autoscaling enabled for this node pool.
`autoprovisioned`	boolean	Can this node pool be deleted automatically.

Responses

200Successful response

Body

Name Data Type Description

Operation


                        Operation

object

This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

Properties


                        zone

string

The name of the Google Compute Engine zone in which the operation is taking place. This field is deprecated, use location instead.


                        targetLink

string

Server-defined URL for the target of the operation.


                        statusMessage

string

If an error has occurred, a textual description of the error.


                        status

string
Allowed values:
- STATUS_UNSPECIFIED
- PENDING
- RUNNING
- DONE
- ABORTING

The current status of the operation.


                        startTime

string

[Output only] The time the operation started, in RFC3339 text format.


                        selfLink

string

Server-defined URL for the resource.


                        operationType

string
Allowed values:
- TYPE_UNSPECIFIED
- CREATE_CLUSTER
- DELETE_CLUSTER
- UPGRADE_MASTER
- UPGRADE_NODES
- REPAIR_CLUSTER
- UPDATE_CLUSTER
- CREATE_NODE_POOL
- DELETE_NODE_POOL
- SET_NODE_POOL_MANAGEMENT
- AUTO_REPAIR_NODES
- AUTO_UPGRADE_NODES
- SET_LABELS
- SET_MASTER_AUTH
- SET_NODE_POOL_SIZE
- SET_NETWORK_POLICY
- SET_MAINTENANCE_POLICY

The operation type.


                        nodepoolConditions

array [StatusCondition]

Which conditions caused the current node pool state.


                        StatusCondition

object

StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

Properties

`message`	string	Human-friendly representation of the condition
`code`	string Allowed values: - `UNKNOWN` - `GCE_STOCKOUT` - `GKE_SERVICE_ACCOUNT_DELETED` - `GCE_QUOTA_EXCEEDED` - `SET_BY_OPERATOR` - `CLOUD_KMS_KEY_ERROR`	Machine-friendly representation of the condition


                        name

string

The server-assigned ID for the operation.


                        location

string

[Output only] The name of the Google Compute Engine zone or region in which the cluster resides.


                        endTime

string

[Output only] The time the operation completed, in RFC3339 text format.


                        detail

string

Detailed operation progress, if available.


                        clusterConditions

array [StatusCondition]

Which conditions caused the current cluster state.


                        StatusCondition

object

StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

Properties

`message`	string	Human-friendly representation of the condition
`code`	string Allowed values: - `UNKNOWN` - `GCE_STOCKOUT` - `GKE_SERVICE_ACCOUNT_DELETED` - `GCE_QUOTA_EXCEEDED` - `SET_BY_OPERATOR` - `CLOUD_KMS_KEY_ERROR`	Machine-friendly representation of the condition

POST

/v1/{name}:setLegacyAbac

Enables or disables the ABAC authorization mechanism on a cluster.

Request

Path

Name	Data Type	Description
`name`	string	The name (project, location, cluster id) of the cluster to set legacy abac. Specified in the format 'projects//locations//clusters/*'.

Body

Name Data Type Description

SetLegacyAbacRequest


                        SetLegacyAbacRequest

object

SetLegacyAbacRequest enables or disables the ABAC authorization mechanism for a cluster.

Properties

`zone`	string	Required. 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.
`projectId`	string	Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.
`name`	string	The name (project, location, cluster id) of the cluster to set legacy abac. Specified in the format 'projects//locations//clusters/*'.
`enabled`	boolean	Required. Whether ABAC authorization will be enabled in the cluster.
`clusterId`	string	Required. Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field.

Responses

200Successful response

Body

Name Data Type Description

Operation


                        Operation

object

This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

Properties


                        zone

string

The name of the Google Compute Engine zone in which the operation is taking place. This field is deprecated, use location instead.


                        targetLink

string

Server-defined URL for the target of the operation.


                        statusMessage

string

If an error has occurred, a textual description of the error.


                        status

string
Allowed values:
- STATUS_UNSPECIFIED
- PENDING
- RUNNING
- DONE
- ABORTING

The current status of the operation.


                        startTime

string

[Output only] The time the operation started, in RFC3339 text format.


                        selfLink

string

Server-defined URL for the resource.


                        operationType

string
Allowed values:
- TYPE_UNSPECIFIED
- CREATE_CLUSTER
- DELETE_CLUSTER
- UPGRADE_MASTER
- UPGRADE_NODES
- REPAIR_CLUSTER
- UPDATE_CLUSTER
- CREATE_NODE_POOL
- DELETE_NODE_POOL
- SET_NODE_POOL_MANAGEMENT
- AUTO_REPAIR_NODES
- AUTO_UPGRADE_NODES
- SET_LABELS
- SET_MASTER_AUTH
- SET_NODE_POOL_SIZE
- SET_NETWORK_POLICY
- SET_MAINTENANCE_POLICY

The operation type.


                        nodepoolConditions

array [StatusCondition]

Which conditions caused the current node pool state.


                        StatusCondition

object

StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

Properties

`message`	string	Human-friendly representation of the condition
`code`	string Allowed values: - `UNKNOWN` - `GCE_STOCKOUT` - `GKE_SERVICE_ACCOUNT_DELETED` - `GCE_QUOTA_EXCEEDED` - `SET_BY_OPERATOR` - `CLOUD_KMS_KEY_ERROR`	Machine-friendly representation of the condition


                        name

string

The server-assigned ID for the operation.


                        location

string

[Output only] The name of the Google Compute Engine zone or region in which the cluster resides.


                        endTime

string

[Output only] The time the operation completed, in RFC3339 text format.


                        detail

string

Detailed operation progress, if available.


                        clusterConditions

array [StatusCondition]

Which conditions caused the current cluster state.


                        StatusCondition

object

StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

Properties

`message`	string	Human-friendly representation of the condition
`code`	string Allowed values: - `UNKNOWN` - `GCE_STOCKOUT` - `GKE_SERVICE_ACCOUNT_DELETED` - `GCE_QUOTA_EXCEEDED` - `SET_BY_OPERATOR` - `CLOUD_KMS_KEY_ERROR`	Machine-friendly representation of the condition

POST

/v1/{name}:setLocations

Sets the locations for a specific cluster.

Request

Path

Name	Data Type	Description
`name`	string	The name (project, location, cluster) of the cluster to set locations. Specified in the format 'projects//locations//clusters/*'.

Body

Name Data Type Description

SetLocationsRequest


                        SetLocationsRequest

object

SetLocationsRequest sets the locations of the cluster.

Properties

`zone`	string	Required. 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.
`projectId`	string	Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.
`name`	string	The name (project, location, cluster) of the cluster to set locations. Specified in the format 'projects//locations//clusters/*'.
`locations`	array [string]	Required. The desired list of Google Compute Engine zones in which the cluster's nodes should be located. Changing the locations a cluster is in will result in nodes being either created or removed from the cluster, depending on whether locations are being added or removed. This list must always include the cluster's primary zone.
`clusterId`	string	Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.

Responses

200Successful response

Body

Name Data Type Description

Operation


                        Operation

object

This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

Properties

`zone`	string	The name of the Google Compute Engine zone in which the operation is taking place. This field is deprecated, use location instead.
`targetLink`	string	Server-defined URL for the target of the operation.
`statusMessage`	string	If an error has occurred, a textual description of the error.
`status`	string Allowed values: - `STATUS_UNSPECIFIED` - `PENDING` - `RUNNING` - `DONE` - `ABORTING`	The current status of the operation.
`startTime`	string	[Output only] The time the operation started, in RFC3339 text format.
`selfLink`	string	Server-defined URL for the resource.
`operationType`	string Allowed values: - `TYPE_UNSPECIFIED` - `CREATE_CLUSTER` - `DELETE_CLUSTER` - `UPGRADE_MASTER` - `UPGRADE_NODES` - `REPAIR_CLUSTER` - `UPDATE_CLUSTER` - `CREATE_NODE_POOL` - `DELETE_NODE_POOL` - `SET_NODE_POOL_MANAGEMENT` - `AUTO_REPAIR_NODES` - `AUTO_UPGRADE_NODES` - `SET_LABELS` - `SET_MASTER_AUTH` - `SET_NODE_POOL_SIZE` - `SET_NETWORK_POLICY` - `SET_MAINTENANCE_POLICY`	The operation type.
`nodepoolConditions`	array [StatusCondition]	Which conditions caused the current node pool state.

Kubernetes Engine

Resources

projects

Request

Path

Body

Properties

Properties

Responses

Body

Properties

Properties

Properties

Request

Path

Body

Properties

Responses

Body

Properties

Properties

Properties

Request

Path

Body

Properties

Responses

Body

Properties

Properties

Properties

Request

Path

Body

Properties

Responses

Body

Properties

Properties

Properties

Request

Path

Body

Properties

Responses

Body

Properties

Properties

Properties

Request

Path

Body

Properties

Responses

Body

Properties

Properties

Properties

Request

Path

Body

Properties

Properties

Responses

Body

Properties

Properties

Properties

Request

Path

Body

Properties

Properties

Responses

Body

Properties

Properties

Properties

Request

Path