更新时间:2022-02-22 GMT+08:00

查询资源恢复能力

功能介绍

查询目标资源是否可恢复。

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_restorable

    List<restorable_param>

    查询参数列表。

    详情请参见表3

  • restorable_param 字段数据结构说明
    表3 restorable_param 字段数据结构说明

    参数

    是否必选

    参数类型

    描述

    checkpoint_item_id

    String

    待恢复的备份ID

    target

    restorable_target

    恢复目标。

    详情请参见表4

  • restorable_target 字段数据结构说明
    表4 restorable_target 字段数据结构说明

    参数

    是否必选

    参数类型

    描述

    resource_id

    String

    待恢复到的目标ID

    resource_type

    String

    待恢复到的目标类型,比如,云服务器取值为:'OS::Nova::Server'

    volumes

    List<restore_volume_mapping>

    云服务器恢复时的卷对应关系列表,请根据实际情况传入卷和备份对应关系

    详情请参见表5

  • restore_volume_mapping 字段数据结构说明
    表5 restore_volume_mapping 字段数据结构说明

    参数

    是否必选

    参数类型

    描述

    backup_id

    String

    卷备份ID,请使用查询单个备份获取卷备份ID。

    volume_id

    String

    恢复目标卷ID。

  • 请求样例
    POST https://{endpoint}/v1/{project_id}/providers/{provider_id}/resources/action
    {
      "check_restorable" : [ {
        "checkpoint_item_id" : "8986ce68-3da7-4d29-9cc2-1921e9504975",
        "target" : {
          "resource_type" : "OS::Nova::Server",
          "resource_id" : "5aa119a8-d25b-45a7-8d1b-88e127885635",
          "volumes" : [ {
            "backup_id" : "7ea119a8-d25b-43a7-8d1b-88e12788513a",
            "volume_id" : "45baf976-c20a-4894-a7c3-c94b7376bf55"
          } ]
        }
      } ]
    }

响应

  • 要素说明
    表6 要素说明

    参数

    参数类型

    描述

    restorable

    List<check_resp>

    响应参数列表。

    详情请参见表7

  • check_resp 字段数据结构说明
    表7 check_resp 字段数据结构说明

    参数

    参数类型

    描述

    result

    Boolean

    是否可恢复

    resource_type

    String

    资源类型

    error_code

    String

    错误码

    error_msg

    String

    错误原因

    resource_id

    String

    资源ID

  • 响应样例
    {
      "restorable" : [ {
        "resource_id" : "6507cb66-90dc-4a12-a573-c9f3398f899d",
        "resource_type" : "OS::Nova::Server",
        "result" : true,
        "error_msg" : "",
        "error_code" : ""
      } ]
    }

状态码

  • 正常

    状态码

    说明

    200

    OK

  • 异常

    状态码

    说明

    400

    请求参数不合法

    401

    鉴权失败

    403

    没有操作权限

    404

    请求对象不存在

    500

    服务内部错误

    503

    服务不可用

错误码

请参考错误码