Domain name for API request: tke.tencentcloudapi.com.
This API is used to upgrade work nodes in a cluster.
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
Parameter Name | Required | Type | Description |
---|---|---|---|
Action | Yes | String | Common Params. The value used for this API: UpgradeClusterInstances. |
Version | Yes | String | Common Params. The value used for this API: 2018-05-25. |
Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
ClusterId | Yes | String | Cluster ID |
Operation | Yes | String | create: starting an upgrade task pause: pausing the task resume: continuing the task abort: stopping the task |
UpgradeType | No | String | Upgrade type. It’s only required when Operation is set as create .reset: the reinstallation and upgrade of major version hot: the hot upgrade of minor version major: in-place upgrade of major version |
InstanceIds.N | No | Array of String | List of nodes that need to upgrade |
ResetParam | No | UpgradeNodeResetParam | This parameter is used when the node joins the cluster again. Refer to the API of creating one or more cluster nodes. |
SkipPreCheck | No | Boolean | Whether to skip the pre-upgrade check of the node |
MaxNotReadyPercent | No | Float | The maximum tolerable proportion of unavailable pods |
UpgradeRunTime | No | Boolean | Whether to upgrade node runtime. Values: true , false (default). |
Parameter Name | Type | Description |
---|---|---|
RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
This example shows you how to upgrade work nodes in the cluster.
https://tke.tencentcloudapi.com/?Action=UpgradeClusterInstances
&ClusterId=cls-xxxxxx
&UpgradeType=reset
&Operation=create
&InstanceIds.0=ins-xxx
&<Common request parameters>
{
"Response": {
"RequestId": "xxx"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
Error Code | Description |
---|---|
FailedOperation.TaskAlreadyRunning | A same task is in progress. |
FailedOperation.TaskLifeStateError | This operation is not supported when the task is in the current status. |
InternalError.ClusterNotFound | Cluster not found. |
InternalError.Param | Parameter error. |
InternalError.TaskAlreadyRunning | A same task is in progress. |
InternalError.TaskLifeStateError | The task in the current state does not support this operation. |
InternalError.TaskNotFound | No task found |
InternalError.UnexceptedInternal | Internal error. |
InvalidParameter.Param | Invalid parameter. |
ResourceNotFound | The resource does not exist. |
ResourceUnavailable.ClusterState | The cluster’s status does support this operation. |
本页内容是否解决了您的问题?