容器服务节点是否可升级-API 文档-文档中心-腾讯云

1. 接口描述

接口请求域名： tke.tencentcloudapi.com 。

检查给定节点列表中哪些是可升级的

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：CheckInstancesUpgradeAble。
Version	是	String	公共参数，本接口取值：2018-05-25。
Region	是	String	公共参数，详见产品支持的地域列表。
ClusterId	是	String	集群ID 示例值：cls-7ph3twqe
InstanceIds.N	否	Array of String	节点列表，空为全部节点示例值：["ins-q40fqbso","ins-hvldgo6w","ins-hrtaxazg"]
UpgradeType	否	String	升级类型，枚举值：reset(重装升级，支持大版本和小版本)，hot(原地滚动小版本升级)，major(原地滚动大版本升级) 示例值："reset"
Offset	否	Integer	分页Offset 示例值：0
Limit	否	Integer	分页Limit 示例值：20
Filter.N	否	Array of Filter	过滤

3. 输出参数

参数名称	类型	描述
ClusterVersion	String	集群master当前小版本示例值：1.20.6
LatestVersion	String	集群master对应的大版本目前最新小版本示例值：1.22.5
UpgradeAbleInstances	Array of UpgradeAbleInstancesItem	可升级节点列表注意：此字段可能返回 null，表示取不到有效值。
Total	Integer	总数注意：此字段可能返回 null，表示取不到有效值。示例值：3
UnavailableVersionReason	Array of UnavailableReason	不可升级原因注意：此字段可能返回 null，表示取不到有效值。
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 检查节点是否可升级

检查节点是否可升级

输入示例

https://tke.tencentcloudapi.com/?Action=CheckInstancesUpgradeAble
&ClusterId=cls-7ph3twqe
&InstanceIds.0=ins-q40fqbso
&InstanceIds.1=ins-hvldgo6w
&InstanceIds.2=ins-hrtaxazg
&<公共请求参数>

输出示例

{
    "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",
                "RuntimeVersion": "docker-18.9",
                "RuntimeLatestVersion": "docker-18.9"
            },
            {
                "InstanceId": "ins-hvldgo6w",
                "LatestVersion": "1.22.5",
                "Version": "1.20.6",
                "RuntimeVersion": "docker-18.9",
                "RuntimeLatestVersion": "docker-18.9"
            },
            {
                "InstanceId": "ins-hrtaxazg",
                "LatestVersion": "1.22.5",
                "Version": "1.20.6",
                "RuntimeVersion": "docker-18.9",
                "RuntimeLatestVersion": "docker-18.9"
            }
        ]
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
FailedOperation.KubeClientConnection	连接用户Kubernetes集群失败。
FailedOperation.KubeCommon	KubernetesAPI错误。
FailedOperation.PolicyServerCommonError	gpe错误。
InternalError	内部错误。
InternalError.Db	db错误。
InternalError.KubeClientConnection	连接用户Kubernetes集群失败。
InternalError.KubeCommon	KubernetesAPI错误。
InternalError.Param	Param。
InternalError.UnexpectedInternal	未知的内部错误。
InvalidParameter	参数错误。
InvalidParameter.Param	参数错误。
ResourceNotFound	资源不存在。
ResourceNotFound.ClusterNotFound	集群不存在。

节点是否可升级

本页目录：