1. 接口描述
接口请求域名: tke.tencentcloudapi.com 。
删除集群中的实例
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DeleteClusterInstances。 |
Version | 是 | String | 公共参数,本接口取值:2018-05-25。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
ClusterId | 是 | String | 集群ID 示例值:cls-xxxxxx |
InstanceIds.N | 是 | Array of String | 主机InstanceId列表 示例值:["ins-xxxxx\r\n"] |
InstanceDeleteMode | 否 | String | 集群实例删除时的策略:terminate(销毁实例,仅支持按量计费云主机实例) retain (仅移除,保留实例) 示例值:terminate |
ForceDelete | 否 | Boolean | 是否强制删除(当节点在初始化时,可以指定参数为TRUE) 示例值:false |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
SuccInstanceIds | Array of String | 删除成功的实例ID列表 注意:此字段可能返回 null,表示取不到有效值。 示例值: ["xxx"] |
FailedInstanceIds | Array of String | 删除失败的实例ID列表 注意:此字段可能返回 null,表示取不到有效值。 示例值: ["xxx"] |
NotFoundInstanceIds | Array of String | 未匹配到的实例ID列表 注意:此字段可能返回 null,表示取不到有效值。 示例值: ["xxx"] |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 删除集群中的实例
删除集群中的实例
输入示例
https://tke.tencentcloudapi.com/?Action=DeleteClusterInstances
&ClusterId=cls-7ph3twqe
&InstanceIds.0=ins-1w67yfj8
&InstanceDeleteMode=terminate
&<公共请求参数>
输出示例
{
"Response": {
"SuccInstanceIds": [
"ins-1w67yfj8"
],
"FailedInstanceIds": [
"ins-1w67yfj9"
],
"NotFoundInstanceIds": [
"ins-1w67yfj0"
],
"RequestId": "eac6b301-a322-493a-8e36-83b295459397"
}
}
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.AsCommon | 伸缩组资源创建报错。 |
FailedOperation.ClusterNotFound | 集群未找到。 |
FailedOperation.ClusterState | 集群状态错误。 |
FailedOperation.CvmDeletionProtection | CVM开启销毁保护,无法移出。 |
FailedOperation.DbRecordNotFound | 记录未找到。 |
FailedOperation.Param | 参数错误。 |
InternalError | 内部错误。 |
InternalError.AsCommon | 伸缩组资源创建报错。 |
InternalError.ClusterNotFound | 集群未找到。 |
InternalError.ClusterState | 集群状态错误。 |
InternalError.Db | db错误。 |
InternalError.DbAffectivedRows | DB错误。 |
InternalError.Param | Param。 |
InternalError.PublicClusterOpNotSupport | 集群不支持当前操作。 |
InternalError.UnexceptedInternal | 内部错误。 |
InvalidParameter | 参数错误。 |
LimitExceeded | 超过配额限制。 |