1. 接口描述
接口请求域名： tke.tencentcloudapi.com 。
给集群的一批work节点进行升级
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：UpgradeClusterInstances。 |
| Version | 是 | String | 公共参数，本接口取值：2018-05-25。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| ClusterId | 是 | String | 集群ID 示例值：cls-xxxxxx |
| Operation | 是 | String | create 表示开始一次升级任务 pause 表示停止任务 resume表示继续任务 abort表示终止任务 示例值：create |
| UpgradeType | 否 | String | 升级类型，只有Operation是create需要设置 reset 大版本重装升级 hot 小版本热升级 major 大版本原地升级 示例值：reset |
| InstanceIds.N | 否 | Array of String | 需要升级的节点列表 示例值：["ins-xxx\n"] |
| ResetParam | 否 | UpgradeNodeResetParam | 当节点重新加入集群时候所使用的参数，参考添加已有节点接口 |
| SkipPreCheck | 否 | Boolean | 是否忽略节点升级前检查 示例值：false |
| MaxNotReadyPercent | 否 | Float | 最大可容忍的不可用Pod比例 示例值：0.90 |
| UpgradeRunTime | 否 | Boolean | 是否升级节点运行时，默认false不升级 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 集群节点升级
给集群的一批work节点进行升级
输入示例
https://tke.tencentcloudapi.com/?Action=UpgradeClusterInstances
&ClusterId=cls-xxxxxx
&UpgradeType=reset
&Operation=create
&InstanceIds.0=ins-xxx
&<公共请求参数>输出示例
{
"Response": {
"RequestId": "xxx"
}
}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. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.TaskAlreadyRunning | 已有相同任务执行中。 |
| FailedOperation.TaskLifeStateError | 任务当前所处状态不支持此操作。 |
| InternalError.ClusterNotFound | 集群未找到。 |
| InternalError.Param | Param。 |
| InternalError.TaskAlreadyRunning | 已有相同任务执行中。 |
| InternalError.TaskLifeStateError | 任务当前所处状态不支持此操作。 |
| InternalError.TaskNotFound | 任务未找到。 |
| InternalError.UnexceptedInternal | 内部错误。 |
| InvalidParameter.Param | 参数错误。 |
| ResourceNotFound | 资源不存在。 |
| ResourceUnavailable.ClusterState | 集群状态不支持该操作。 |
