tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
文档

CheckInstancesUpgradeAble

最后更新时间：2023-09-18 16:00:21

1. API Description

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

This API is used to query nodes eligible for an upgrade 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 Params. The value used for this API: CheckInstancesUpgradeAble.
Version Yes String Common Params. The value used for this API: 2018-05-25.
Region No String Common Params. This parameter is not required for this API.
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.
UnavailableVersionReason Array of UnavailableReason Reason why the upgrade is not available
Note: This field may return null, indicating that no valid values can be 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

This example shows you how to check whether the node can be upgraded.

Input Example

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

Output Example

{
    "Response": {
        "ClusterVersion": "1.22.5",
        "LatestVersion": "1.22.5",
        "Total": 3,
        "RequestId": "123",
        "UnavailableVersionReason": {
            "InstanceId": "ins-mq0fqbso",
            "Reason": "instance already the master latest version"
        },
        "UpgradeAbleInstances": [
            {
                "InstanceId": "ins-q40fqbso",
                "LatestVersion": "1.22.5",
                "Version": "1.20.6"
            },
            {
                "InstanceId": "ins-hvldgo6w",
                "LatestVersion": "1.22.5",
                "Version": "1.20.6"
            },
            {
                "InstanceId": "ins-hrtaxazg",
                "LatestVersion": "1.22.5",
                "Version": "1.20.6"
            }
        ]
    }
}

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
FailedOperation.KubeClientConnection Failed to connect to the customer Kubernetes cluster.
FailedOperation.KubeCommon Kubernetes API error.
FailedOperation.PolicyServerCommonError GPE error.
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 The resource does not exist.
ResourceNotFound.ClusterNotFound The cluster does not exist.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
隐私条款服务条款缓存条款