批量删除保护实例

功能介绍

批量删除保护实例。

约束与限制

• 保护实例的状态为available、protected、failed-over、error、error-starting、error-stopping、error-reversing、error-failing-over、error-deleting、error-reprotecting、error-resizing、invalid、fault。
• 保护实例都属于同一个保护组
• 保护实例上挂载的共享云硬盘复制对有多个挂载点时，请确保共享云硬盘复制对挂载的保护实例都在待删除的保护实例列表中。

URI

• URI格式

  POST /v1/{project_id}/protected-instances/delete

• 参数说明

  参数名称	是否必选	参数类型	说明
  project_id	是	String	项目ID。 获取方法请参见获取项目ID。

请求消息

• 参数说明

  参数名称	是否必选	参数类型	说明
  protected_instances	是	Array of objects	所需要删除的保护实例列表，详情请参见表1 说明： 默认支持的保护实例个数上限为20个
  delete_target_server	否	Boolean	是否删除容灾站点服务器，默认值为false。
  delete_target_eip	否	Boolean	是否删除容灾站点弹性IP，默认值为false。

  表1 protected_instance字段数据结构说明

  参数名称	是否必选	参数类型	说明
  id	是	String	保护实例的ID。 具体参数请参考查询保护实例列表接口。

• 请求样例
  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
  }

响应

• 要素说明

  参数名称	参数类型	说明
  job_id	String	执行异步API命令下发成功的返回参数，任务执行结果请参考查询job状态接口。

• 响应样例

  { 
     "job_id": "0000000062db92d70162db3ab00f00df" 
   }

  或

  { 
       "error": { 
           "message": "XXXX",  
           "code": "XXX" 
       } 
   }

  其中error是泛指的错误，有badrequest、itemNotFound等，如报错为：

  { 
       "badrequest": { 
           "message": "XXXX",  
           "code": "XXX" 
       } 
   }

返回值

• 正常

  返回值	说明
  202	服务器已接受请求。

• 异常

  返回值	说明
  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	网关超时。