CheckInstancesUpgradeAble

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

1. API Description

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

This API is used to check which nodes can be upgraded in the given node list.

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: CheckInstancesUpgradeAble.
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
InstanceIds.N No Array of String Specify the node list to check. If it’s not passed in, all nodes of the cluster will be checked.
UpgradeType No String Upgrade type
Offset No Integer Pagination offset
Limit No Integer Pagination limit
Filter.N No Array of Filter Filtering

3. Output Parameters

Parameter Name Type Description
ClusterVersion String The current minor version of cluster Master
LatestVersion String The latest minor version of cluster Master corresponding major version
UpgradeAbleInstances Array of UpgradeAbleInstancesItem List of nodes that can be upgraded
Note: this field may return null, indicating that no valid value is obtained.
Total Integer Total number
Note: this field may return null, indicating that no valid value is obtained.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Checking whether the node can be upgraded

Input Example

https://tke.tencentcloudapi.com/?Action=CheckInstancesUpgradeAble
&ClusterId=cls-xxxxxx
&InstanceIds.0=ins-q40fqbso
&InstanceIds.1=ins-hvldgo6w
&InstanceIds.2=ins-hrtaxazg
&<Common request parameters>

Output Example

{
  "Response": {
    "ClusterVersion": "1.14.3-tk8s-v1.1-1",
    "LatestVersion": "1.14.3-tk8s-v1.1-1",
    "Total": 3,
    "RequestId": "123",
    "UpgradeAbleInstances": [
      {
        "InstanceId": "ins-q40fqbso",
        "LatestVersion": "xx",
        "Version": "1.14.3-tk8s-v1.0"
      },
      {
        "InstanceId": "ins-hvldgo6w",
        "LatestVersion": "xx",
        "Version": "1.14.3-tk8s-v1.0"
      },
      {
        "InstanceId": "ins-hrtaxazg",
        "LatestVersion": "xx",
        "Version": "1.14.3-tk8s-v1.0"
      }
    ]
  }
}

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.Db DB error.
InternalError.KubeClientConnection Failed to connect to the user’s Kubernetes cluster.
InternalError.KubeCommon Kubernetes API error.
InternalError.Param Parameter error.
InternalError.UnexpectedInternal Unknown internal error.
InvalidParameter Parameter error.
InvalidParameter.Param Invalid parameter.
ResourceNotFound.ClusterNotFound The cluster does not exist.