用户指南

最佳实践

API 文档

集群节点升级

最近更新时间:2022-01-25 08:18:32

我的收藏

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
Operation String create 表示开始一次升级任务
pause 表示停止任务
resume表示继续任务
abort表示终止任务
UpgradeType String 升级类型,只有Operation是create需要设置
reset 大版本重装升级
hot 小版本热升级
major 大版本原地升级
InstanceIds.N Array of String 需要升级的节点列表
ResetParam UpgradeNodeResetParam 当节点重新加入集群时候所使用的参数,参考添加已有节点接口
SkipPreCheck Boolean 是否忽略节点升级前检查
MaxNotReadyPercent Float 最大可容忍的不可用Pod比例

3. 输出参数

参数名称 类型 描述
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 集群节点升级

输入示例

https://tke.tencentcloudapi.com/?Action=UpgradeClusterInstances
&ClusterId=cls-xxxxxx
&UpgradeType=reset
&Operation=create
&InstanceIds.0=ins-xxx
&<公共请求参数>

输出示例

{
  "Response": {
    "RequestId": "xx"
  }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InternalError.ClusterNotFound 集群未找到。
InternalError.Param Param。
InternalError.TaskAlreadyRunning 已有相同任务执行中。
InternalError.TaskLifeStateError 任务当前所处状态不支持此操作。
InternalError.TaskNotFound 任务未找到。
InternalError.UnexceptedInternal 内部错误。
InvalidParameter.Param 参数错误。
ResourceUnavailable.ClusterState 集群状态不支持该操作。
目录