1. 接口描述
接口请求域名: tke.tencentcloudapi.com 。
重启原生节点实例
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:RebootMachines。 |
Version | 是 | String | 公共参数,本接口取值:2022-05-01。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
ClusterId | 是 | String | 集群 ID 示例值:cls-0dku0jec |
MachineNames.N | 是 | Array of String | 节点名字列表,一次请求,传入节点数量上限为100个 示例值:["np-5tx2l4dc-4tzgqy", "np-5tx2l4dc-fb8jl"] |
StopType | 否 | String | 实例的关闭模式。取值范围: soft_first:表示在正常关闭失败后进行强制关闭 hard:直接强制关闭 soft:仅软关机默认取值:soft。 示例值:soft |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 重启原生节点实例
该接口支持原生节点重启,重启时限制一次重启的原生节点数量最多为100个
输入示例
POST / HTTP/1.1
Host: tke.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: RebootMachines
<公共请求参数>
{
"ClusterId": "cls-0dku0jec",
"MachineNames": [
"np-5tx2l4dc-4srqm",
"np-5tx2l4dc-4srqn"
],
"StopType": "soft"
}
输出示例
{
"Response": {
"RequestId": "3c0b712f-28a8-42a7-a89a-b4448a01421f"
}
}
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: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InvalidParameterValue | 参数取值错误。 |
OperationDenied | 操作被拒绝。 |
ResourceNotFound | 资源不存在。 |