1. 接口描述
接口请求域名： tke.tencentcloudapi.com 。
获得节点升级当前的进度，若集群未处于节点升级状态，则接口会报错：任务未找到。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：GetUpgradeInstanceProgress。 |
| Version | 是 | String | 公共参数，本接口取值：2018-05-25。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| ClusterId | 是 | String | 集群ID 示例值：cls-7ph3twqe |
| Limit | 否 | Integer | 最多获取多少个节点的进度 示例值：10 |
| Offset | 否 | Integer | 从第几个节点开始获取进度 示例值：0 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Total | Integer | 升级节点总数 示例值：3 |
| Done | Integer | 已升级节点总数 示例值：3 |
| LifeState | String | 升级任务生命周期 process 运行中 paused 已停止 pauing 正在停止 done 已完成 timeout 已超时 aborted 已取消 示例值：done |
| Instances | Array of InstanceUpgradeProgressItem | 各节点升级进度详情 示例值：{} |
| ClusterStatus | InstanceUpgradeClusterStatus | 集群当前状态 示例值：{} |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询升级状态
查询升级状态
输入示例
https://tke.tencentcloudapi.com/?Action=GetUpgradeInstanceProgress
&ClusterId=cls-xxxxxx
&<公共请求参数>输出示例
{
"Response": {
"Total": 0,
"Done": 0,
"LifeState": "abc",
"Instances": [
{
"InstanceID": "ins-wggphft5",
"LifeState": "paused",
"StartAt": "2021-02-08T16:29:46+08:00",
"EndAt": "2021-02-08T16:39:46+08:00",
"CheckResult": {
"CheckPass": false,
"Items": [
{
"Namespace": "default",
"WorkLoadKind": "ReplicaSet",
"WorkLoadName": "kubernetes-proxy-67fd23cf4d",
"Before": 1,
"After": 0,
"Pods": [
"kubernetes-proxy-67fd23cf4d-2tcxw"
]
}
],
"SinglePods": []
},
"Detail": [
{
"EndAt": null,
"FailedMsg": "precheck failed",
"LifeState": "failed",
"StartAt": "2023-02-08T08:29:51Z",
"Step": "preCheck"
},
{
"EndAt": null,
"FailedMsg": "",
"LifeState": "pending",
"StartAt": null,
"Step": "drain"
},
{
"EndAt": null,
"FailedMsg": "",
"LifeState": "pending",
"StartAt": null,
"Step": "remove"
},
{
"EndAt": null,
"FailedMsg": "",
"LifeState": "pending",
"StartAt": null,
"Step": "reset"
},
{
"EndAt": null,
"FailedMsg": "",
"LifeState": "pending",
"StartAt": null,
"Step": "postCheck"
}
]
}
],
"ClusterStatus": {
"PodTotal": 10,
"NotReadyPod": 0
},
"RequestId": "b224fa4b-fedf-4061-baa9-d547ew858df"
}
}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
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError.TaskNotFound | 任务未找到。 |
| InternalError.UnexpectedInternal | 未知的内部错误。 |
| InvalidParameter.Param | 参数错误。 |
