UpdateClusterVersion

Last updated: 2021-05-12 10:27:37

1. API Description

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

This API is used to upgrade the master component of the cluster to the specified version.

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

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: tke.ap-shanghai-fsi.tencentcloudapi.com

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: UpdateClusterVersion.
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
DstVersion Yes String The version that needs to upgrade to
ExtraArgs No ClusterExtraArgs Cluster custom parameter
MaxNotReadyPercent No Float The maximum tolerable number of unavailable pods
SkipPreCheck No Boolean Whether to skip the precheck

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 the cluster to the specified version

Input Example

https://tke.tencentcloudapi.com/?Action=UpdateClusterVersion
&ClusterId=cls-xxxxxxxx
&DstVersion=1.8.13
&<Common request parameters>

Output Example

{
  "Response": {
    "RequestId": "2ac430cd-f7de-482e-b98e-f78a48e785e8"
  }
}

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

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 Internal error.
InternalError.Param Parameter error.
InternalError.UnexpectedInternal Unknown internal error.
InvalidParameter Parameter error.
InvalidParameter.Param Invalid parameter.
ResourceUnavailable.ClusterState The cluster’s status does support this operation.