UpgradeCluster - Container Service for Kubernetes - Alibaba Cloud Documentation Center

This topic is generated by a machine translation engine without any human intervention. ALIBABA CLOUD DOES NOT GUARANTEE THE ACCURACY OF MACHINE TRANSLATED CONTENT. To request a human-translated version of this topic or provide feedback on this translation, please include it in the feedback form.

You can call the UpgradeCluster operation to upgrade a cluster by cluster ID.

Operation description

After successfully calling the UpgradeCluster interface, this API returns the task_id of the upgrade task. You can manage this operation task by calling the following task APIs:

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
cs:UpgradeCluster	update	*Cluster `acs:cs:{#regionId}:{#accountId}:cluster/{#ClusterId}`	none	none

Request syntax

POST /api/v2/clusters/{ClusterId}/upgrade HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
ClusterId	string	Yes	The ID of the cluster that you want to upgrade.	c82e6987e2961451182edacd74faf****
body	object	No	The request body parameters.
component_name`deprecated`	string	No	This parameter is deprecated.	k8s
next_version	string	No	The Kubernetes version to which you want to update the cluster.	1.16.9-aliyun.1
version`deprecated`	string	No	This parameter is deprecated. Specify the Kubernetes version by using the next_version parameter.	1.14.8-aliyun.1
master_only	boolean	No	Specifies whether to update only the master nodes. Valid values: true: updates only the master nodes. false: updates the master nodes and worker nodes.	true
rolling_policy	object	No	The rotation configuration.
max_parallelism	integer	No	The maximum size of each batch.	3

Response parameters

Parameter	Type	Description	Example
	object
cluster_id	string	Cluster ID.	c82e6987e2961451182edacd74faf****
task_id	string	Task ID.	T-5faa48fb31b6b8078d00****
request_id	string	Request ID.	0527ac9a-c899-4341-a21a-****

Examples

Sample success responses

JSONformat

{
  "cluster_id": "c82e6987e2961451182edacd74faf****",
  "task_id": "T-5faa48fb31b6b8078d00****",
  "request_id": "0527ac9a-c899-4341-a21a-****"
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-08-14	The internal configuration of the API is changed, but the call is not affected	View Change Details
2024-01-12	The response structure of the API has changed	View Change Details
2023-09-07	The internal configuration of the API is changed, but the call is not affected	View Change Details