Call the UpgradeClusterAddons API to upgrade cluster add-ons - Container Service for Kubernetes - Alibaba Cloud - Container Service for Kubernetes

Updates cluster components to use new features and patch vulnerabilities. You must update cluster components one after one and update a component only after the previous one is successfully updated. Before you update a component, we recommend that you read the update notes for each component. Cluster component updates may affect your businesses. Assess the impact, back up data, and perform the update during off-peak hours.

Operation description

升级集群组件实例版本可能会影响业务，请评估影响后在业务低峰期操作并提前做好相关的数据备份。
升级组件前，请参考组件发布记录了解指定组件的变更内容和变更影响。
请依次逐个组件升级，确认一个组件升级成功后再升级下一个组件。

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:UpgradeK8sComponents

update

*Cluster

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

None

Request syntax

POST /clusters/{ClusterId}/components/upgrade HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
ClusterId	string	Yes	The cluster ID.	cf4299b79b3e34226abfdc80a4bda****

Request parameters

Parameter	Type	Required	Description	Example
body	array<object>	No	The request parameters.
	object	No
component_name	string	Yes	The name of the component.	coredns
next_version	string	Yes	The version to which the component can be updated. You can call the `DescribeClusterAddonsVersion` operation to query the version to which the component can be updated.	v1.11.3.5-5321daf49-aliyun
version	string	No	The current version of the component.	v1.11.3.2-f57ea7ed6-aliyun
config	string	No	The custom component settings that you want to use. The value is a JSON string.	{"CpuRequest":"800m"}
policy	string	No	The update policy. Valid values: overwrite canary	canary

Response elements

Element	Type	Description	Example
	object
cluster_id	string	The cluster ID.	cf4299b79b3e34226abfdc80a4bda****
request_id	string	The request ID.	bfd12953-31cb-42f1-8a36-7b80ec34****
task_id	string	The task ID.	T-62a944794ee141074400****

Examples

Success response

JSON format

{
  "cluster_id": "cf4299b79b3e34226abfdc80a4bda****",
  "request_id": "bfd12953-31cb-42f1-8a36-7b80ec34****",
  "task_id": "T-62a944794ee141074400****"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.