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.
Debugging
Authorization information
Request syntax
POST /clusters/{ClusterId}/components/upgrade
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| ClusterId | string | Yes | The cluster ID. | cf4299b79b3e34226abfdc80a4bda**** |
| 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 | 1.6.7 |
| version | string | No | The current version of the component. | v1.6.2 |
| 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:
| canary |
Response parameters
Examples
Sample success responses
JSONformat
{
"cluster_id": "cf4299b79b3e34226abfdc80a4bda****",
"request_id": "bfd12953-31cb-42f1-8a36-7b80ec345094",
"task_id": "T-62a944794ee141074400****"
}Error codes
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2024-07-24 | The response structure of the API has changed | View Change Details |
| 2024-03-12 | The internal configuration of the API is changed, but the call is not affected | View Change Details |