TerminateHosts
最近更新时间: 2025-10-20 17:05:58
1. 接口描述
接口请求域名： cvm.api3.fincloud.tencent.cn。
用于主动退还CDH
默认接口请求频率限制：20次/秒。
接口更新时间：2023-07-19 10:40:59。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：TerminateHosts |
| Version | 是 | 否 | String | 公共参数，本接口取值：2017-03-12 |
| Region | 是 | 否 | String | 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| HostIds | 是 | 否 | Array of String | 一个或多个待操作的CDH实例ID。 |
| DryRun | 否 | 否 | Bool | 是否跳过实际执行逻辑。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TaskId | String | 此参数对外不可见。 任务ID |
| FlowId | Int64 | 此参数对外不可见。 任务流转ID |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidHostId.NotFound | 指定的HostId不存在，或不属于该请求账号所有。 |
| InvalidHostId.Malformed | 无效CDH ID。指定的CDH ID格式错误。例如ID长度错误host-1122。 |
| MissingParameter | 参数缺失。请求没有带必选参数。 |
| InvalidHost.NotSupported | 不支持该宿主机实例执行指定的操作。 |