UpgradeClusterInstances

Download PDF

Last updated: 2021-10-20 16:47:41

Download PDF

1. API Description

Domain name for API request: tke.tencentcloudapi.com.

This API is used to upgrade one or more work nodes in the cluster.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

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 parameter. The value used for this API: UpgradeClusterInstances.
Version	Yes	String	Common parameter. The value used for this API: 2018-05-25.
Region	Yes	String	Common parameter. 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

3. Output Parameters

Parameter Name	Type	Description
RequestId	String	The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Upgrading cluster nodes

Input Example

https://tke.tencentcloudapi.com/?Action=UpgradeClusterInstances
&ClusterId=cls-xxxxxx
&UpgradeType=reset
&Operation=create
&InstanceIds.0=ins-xxx
&<Common request parameters>

Output Example

{
  "Response": {
    "RequestId": "xx"
  }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code	Description
InternalError.ClusterNotFound	Cluster not found.
InternalError.Param	Parameter error.
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.
ResourceUnavailable.ClusterState	The cluster’s status does support this operation.

Recent Pages