Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-1364261347.5 KB
projects

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

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

Path parameters

projectIdstring required

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

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

clusterIdstring required

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

nodePoolIdstring required

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

Request body

flexStartboolean

Flex Start flag for enabling Flex Start VM.

consolidationDelaystring google-duration

Consolidation delay defines duration after which the Cluster Autoscaler can scale down underutilized nodes. If not set, nodes are scaled down by default behavior, i.e. according to the chosen autoscaling profile.

storagePoolsstring[]

List of Storage Pools where boot disks are provisioned. Existing Storage Pools will be replaced with storage-pools.

zonestring

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.

nodeVersionstring

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

namestring

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

imageProjectstring

The project containing the desired image to use for this node pool. This is used to create clusters using a custom image.

clusterIdstring

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

diskSizeGbstring int64

Optional. The desired disk size for nodes in the node pool specified in GB. The smallest allowed disk size is 10GB. Initiates an upgrade operation that migrates the nodes in the node pool to the specified disk size.

imagestring

The desired name of the image name to use for this node. This is used to create clusters using a custom image.

diskTypestring

Optional. The desired disk type (e.g. 'pd-standard', 'pd-ssd' or 'pd-balanced') for nodes in the node pool. Initiates an upgrade operation that migrates the nodes in the node pool to the specified disk type.

projectIdstring

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

machineTypestring

Optional. The desired Google Compute Engine machine type for nodes in the node pool. Initiates an upgrade operation that migrates the nodes in the node pool to the specified machine type.

maxRunDurationstring google-duration

The maximum duration for the nodes to exist. If unspecified, the nodes can exist indefinitely.

imageTypestring

Required. The desired image type for the node pool. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types.

locationsstring[]

The desired list of Google Compute Engine zones in which the node pool's nodes should be located. Changing the locations for a node pool will result in nodes being either created or removed from the node pool, depending on whether locations are being added or removed. Warning: It is recommended to update node pool locations in a standalone API call. Do not combine a location update with changes to other fields (such as tags, labels, taints, etc.) in the same request. Otherwise, the API performs a structural modification where changes to other fields will only apply to newly created nodes and will not be applied to existing nodes in the node pool. To ensure all nodes are updated consistently, use a separate API call for location changes.

etagstring

The current etag of the node pool. If an etag is provided and does not match the current etag of the node pool, update will be blocked and an ABORTED error will be returned.

nodePoolIdstring

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

Response

Successful response