DeleteClusterInstances
最近更新时间: 2025-10-20 17:05:58
1. 接口描述
接口请求域名： tke.api3.fincloud.tencent.cn。
删除集群中的实例
默认接口请求频率限制：20次/秒。
接口更新时间：2021-05-10 11:17:55。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：DeleteClusterInstances |
| Version | 是 | 否 | String | 公共参数，本接口取值：2018-05-25 |
| Region | 是 | 否 | String | 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| ClusterId | 是 | 否 | String | 集群ID |
| InstanceIds | 是 | 否 | Array of String | 主机InstanceId列表 |
| InstanceDeleteMode | 否 | 否 | String | 集群实例删除时的策略：terminate（销毁实例，仅支持按量计费云主机实例） retain （仅移除，保留实例） |
| ForceDelete | 否 | 否 | Bool | 是否强制删除(当节点在初始化时，可以指定参数为TRUE) |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| SuccInstanceIds | String | 成功删除的cvm实例id列表 |
| FailedInstanceIds | String | 未成功删除的cvm实例id列表 |
| NotFoundInstanceIds | String | 未找到的cvm实例id列表 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError | 内部错误 |
| InternalError.DbAffectivedRows | DB错误 |
| InvalidParameter | 参数错误 |
| LimitExceeded | 超过配额限制 |
| InternalError.Db | db错误。 |
| InternalError.Param | Param。 |
| InternalError.PublicClusterOpNotSupport | 集群不支持当前操作。 |