批量删除实例 - DeleteInstances
功能介绍
批量删除实例,此接口为异步接口,可通过 ShowInstanceStatus 查询实例状态,实例状态从 shutting-down 变为 terminated,表明删除实例成功。
调用方法
请参见如何调用API。
授权信息
账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。
| 授权项 | 访问级别 | 资源类型(*为必须) | 条件键 | 别名 | 依赖的授权项 |
|---|---|---|---|---|---|
| clouddc:instance:deleteBatch | Write | - | - | - | - |
URI
POST /v1/{project_id}/instances/batch-delete
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID 约束限制: 不涉及 取值范围: 账号的项目ID 默认取值: 不涉及 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 调用接口的认证方式分为Token,如果您使用的Token方式,此参数为必填,请填写Token的值 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| instance_id_set | 否 | Array of strings | 参数解释: 实例id 列表 约束限制: 服务器id不超过50条 |
响应参数
状态码:202
| 参数 | 参数类型 | 描述 |
|---|---|---|
| instances | Array of instances objects | 参数解释: 实例返回信息 约束限制: 不涉及 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码 |
| error_msg | String | 参数解释: 错误描述 |
状态码:401
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码 |
| error_msg | String | 参数解释: 错误描述 |
状态码:429
| 参数 | 参数类型 | 描述 |
|---|---|---|
| - | String | - |
状态码:500
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码 |
| error_msg | String | 参数解释: 错误描述 |
请求示例
批量删除实例
POST https://{endpoint}/v1/{project_id}/instances/batch-delete 响应示例
状态码:202
批量删除实例应答
{
"instances" : [ {
"id" : "0198170e-4ca7-7ee4-89a7-fa631843920b"
} ]
} 状态码
| 状态码 | 描述 |
|---|---|
| 202 | 批量删除实例应答 |
| 400 | 请求参数错误,请求失败 |
| 401 | 请求未鉴权 |
| 429 | 请求过载 |
| 500 | 服务端内部错误 |
错误码
请参见错误码。