Call UpgradeClusterNodepool to update the Kubernetes OS or runtime version of a node pool - Container Service for Kubernetes - Alibaba Cloud - Container Service for Kubernetes

Upgrades the kubelet version (recommended to match the control plane version), operating system version, or container runtime version of a specified cluster node pool.

Operation description

Upgrades the Kubernetes version, operating system version, or container runtime version of nodes in a specified cluster node pool. After you successfully call the UpgradeClusterNodepool operation, the API returns a task_id for the upgrade task. You can manage the task by calling the following task-related API operations:

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

cs:UpgradeClusterNodepool

update

*Cluster

acs:cs:{#regionId}:{#accountId}:cluster/{#ClusterId}

None

Request syntax

POST /clusters/{ClusterId}/nodepools/{NodepoolId}/upgrade HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
ClusterId	string	Yes	The cluster ID.	c106f377e16f34eb1808d6b9362c9****
NodepoolId	string	Yes	The node pool ID.	np31da1b38983f4511b490fc62108a****

Request parameters

Parameter	Type	Required	Description	Example
body	object	No	The request parameters.
image_id	string	No	The system image ID of the node.	aliyun_3_x64_20G_container_optimized_20241226.vhd
runtime_version	string	No	The runtime version of the node. You can call DescribeKubernetesVersionMetadata to obtain the runtime version information from the runtime field.	1.6.36
kubernetes_version	string	No	The Kubernetes version of the node. You can call DescribeKubernetesVersionMetadata to obtain the current cluster version information from `KubernetesVersion`.	1.32.1-aliyun.1
runtime_type	string	No	The runtime type. You can call DescribeKubernetesVersionMetadata to obtain the runtime information from the runtime field.	containerd
use_replace	boolean	No	Specifies whether to use disk replacement for the upgrade. Valid values: true: Uses disk replacement to upgrade the node pool. ACK reinitializes the nodes based on the current node pool configurations, such as logon method, labels, taints, operating system image, and runtime version. false: Does not use disk replacement. Default value: false.	false
rolling_policy	object	No	The rolling update configuration.
pause_policy	string	No	The automatic pause policy during node upgrades. Valid values: FirstBatch: Pauses after the first batch is complete. EveryBatch: Pauses after each batch is complete. NotPause: Does not pause.	NotPause
batch_interval	integer	No	The upgrade interval between batches. This parameter takes effect only when the pause policy is set to `NotPause`. Valid values: [5,120]. Unit: minutes. This parameter can be set to 0, which indicates no interval between batches.	5
max_parallelism	integer	No	The maximum number of nodes that can be updated in parallel per batch. Node pool updates are performed in batches. Valid values: [1,10]. Default value: 10.	2
max_failed_nodes	integer	No	The maximum number of nodes that are allowed to fail during the rolling update. Default value: 0, which indicates that the task fails if any node fails. If the value is greater than 0, the task fails and stops when the cumulative number of failed nodes exceeds this value.	0
node_names	array	No	The list of nodes to upgrade. If not specified, all nodes in the node pool are upgraded by default.
	string	No	The node name, which serves as the node identifier within the cluster.	cn-beijing.10.180.xx.xx
ignore_warning_check	boolean	No	Specifies whether to ignore warning-level pre-checks.

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	2D69A58F-345C-4FDE-88E4-BF518944****
task_id	string	The task ID.	T-5fd211e924e1d0078700****

Examples

Success response

JSON format

{
  "RequestId": "2D69A58F-345C-4FDE-88E4-BF518944****",
  "task_id": "T-5fd211e924e1d0078700****"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.