查询资源备份能力

功能介绍

查询资源是否可以备份。

URI

• URI

  POST https://{endpoint}/v1/{project_id}/providers/{provider_id}/resources/action

• 参数说明

  表1 参数说明

  参数	是否必选	参数类型	描述
  project_id	是	String	项目ID。 获取方法请参见获取项目ID。
  provider_id	是	String	备份提供商ID，当前取值固定值：fc4d5750-22e7-4798-8a46-f48f62c4c1da。用于区分备份对象是服务器或磁盘。

请求

• 要素说明

  表2 要素说明

  参数	是否必选	参数类型	描述
  check_protectable	是	List<protectable_param>	查询参数列表。 详情请参见表3。

• protectable_param 字段数据结构说明

  表3 protectable_param 字段数据结构说明

  参数	是否必选	参数类型	描述
  resource_id	是	String	待检查资源ID，云服务器ID或者云硬盘ID 服务器ID请参见《弹性云服务器API参考》获取，磁盘ID请参见《云硬盘API参考》获取。
  resource_type	是	String	待检查的资源类型。 当前支持的取值包含两个：OS::Nova::Server，该值代表保护的资源为云服务器，OS::Ironic::BareMetalServer，该值代表保护的资源为裸金属服务器。

• 请求样例

  POST https://{endpoint}/v1/{project_id}/providers/{provider_id}/resources/action
  {
    "check_protectable" : [ {
      "resource_id" : "6507cb66-90dc-4a12-a573-c9f3398f899d",
      "resource_type" : "OS::Nova::Server"
    } ]
  }

响应

• 要素说明

  表4 要素说明

  参数	参数类型	描述
  protectable	List<check_resp>	检查结果列表。 详情请参见表5。

• check_resp 字段数据结构说明

  表5 check_resp 字段数据结构说明

  参数	参数类型	描述
  result	Boolean	是否可备份或恢复 true: 支持备份 false: 不支持备份
  resource_type	String	资源类型 当前支持的取值包含两个：OS::Nova::Server，该值代表保护的资源为云服务器，OS::Ironic::BareMetalServer，该值代表保护的资源为裸金属服务器。
  error_code	String	错误码，当发生错误时有返回值
  error_msg	String	错误原因,兼容判断虚拟机是否已绑定策略错误，当发生错误时有返回值
  resource_id	String	资源ID

• 响应样例

  {
    "protectable" : [ {
      "resource_id" : "6507cb66-90dc-4a12-a573-c9f3398f899d",
      "resource_type" : "OS::Nova::Server",
      "result" : true
    } ]
  }

状态码

• 正常

  状态码	说明
  200	OK

• 异常

  状态码	说明
  400	请求参数不合法
  401	鉴权失败
  403	没有操作权限
  404	请求对象不存在
  500	服务内部错误
  503	服务不可用

错误码

请参考错误码。