批量删除保护实例 - BatchDeleteProtectedInstances
功能介绍
典型场景:没有特殊操作场景 接口功能:批量删除保护实例。
接口约束
接口约束:保护实例的状态为available、protected、failed-over、error、error-starting、error-stopping、error-reversing、error-failing-over、error-deleting、error-reprotecting、error-resizing、invalid、fault;保护实例都属于同一个保护组;保护实例上挂载的共享复制对有多个挂载点时,请先卸载共享复制对再删除保护实例。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
POST /v1/{project_id}/protected-instances/delete
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 项目ID。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值) |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| protected_instances | 是 | Array of ResourceId objects | 所需要删除的保护实例列表。 |
| delete_target_server | 否 | Boolean | 是否删除容灾站点服务器,默认值为false。 缺省值:false |
| delete_target_eip | 否 | Boolean | 是否删除容灾站点弹性IP,默认值为false。 缺省值:false |
响应参数
状态码: 202
| 参数 | 参数类型 | 描述 |
|---|---|---|
| job_id | String | 成功返回jobId信息 |
状态码: 400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error | ErrorInfo object | 失败返回结构 |
状态码: 401
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error | ErrorInfo object | 失败返回结构 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| message | String | 错误信息 |
| code | String | 错误码 |
状态码: 403
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error | ErrorInfo object | 失败返回结构 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| message | String | 错误信息 |
| code | String | 错误码 |
状态码: 404
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error | ErrorInfo object | 失败返回结构 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| message | String | 错误信息 |
| code | String | 错误码 |
状态码: 405
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error | ErrorInfo object | 失败返回结构 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| message | String | 错误信息 |
| code | String | 错误码 |
状态码: 406
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error | ErrorInfo object | 失败返回结构 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| message | String | 错误信息 |
| code | String | 错误码 |
状态码: 407
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error | ErrorInfo object | 失败返回结构 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| message | String | 错误信息 |
| code | String | 错误码 |
状态码: 408
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error | ErrorInfo object | 失败返回结构 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| message | String | 错误信息 |
| code | String | 错误码 |
状态码: 409
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error | ErrorInfo object | 失败返回结构 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| message | String | 错误信息 |
| code | String | 错误码 |
状态码: 500
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error | ErrorInfo object | 失败返回结构 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| message | String | 错误信息 |
| code | String | 错误码 |
状态码: 501
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error | ErrorInfo object | 失败返回结构 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| message | String | 错误信息 |
| code | String | 错误码 |
状态码: 502
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error | ErrorInfo object | 失败返回结构 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| message | String | 错误信息 |
| code | String | 错误码 |
状态码: 503
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error | ErrorInfo object | 失败返回结构 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| message | String | 错误信息 |
| code | String | 错误码 |
状态码: 504
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error | ErrorInfo object | 失败返回结构 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| message | String | 错误信息 |
| code | String | 错误码 |
请求示例
POST https://{Endpoint}/v1/{project_id}/protected-instances/delete
{
"protected_instances" : [ {
"id" : "127842d5-f98e-451e-963e-9fb464fbb911"
}, {
"id" : "8f5dd226-6cc0-4fe8-9786-b8b3359b234b"
} ],
"delete_target_server" : false,
"delete_target_eip" : false
} 响应示例
状态码: 202
Accepted
{
"job_id" : "0000000062db92d70162db9d200f00bb"
} 状态码: 400
Bad Request
{
"error" : {
"message" : "Number of servers exceeds the upper limit",
"code" : "SDRS.1362"
}
} 状态码
| 状态码 | 描述 |
|---|---|
| 202 | Accepted |
| 400 | Bad Request |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
| 405 | Method Not Allowed |
| 406 | Not Acceptable |
| 407 | Proxy Authentication Required |
| 408 | Request Timeout |
| 409 | Conflict |
| 500 | Internal Server Error |
| 501 | Not Implemented |
| 502 | Bad Gateway |
| 503 | Service Unavailable |
| 504 | Gateway Timeout |
错误码
请参见错误码。