文档首页/ 云备份 CBR/ API参考/ API/ 还原点/ 查询备份还原点
更新时间：2024-05-11 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询备份还原点

功能介绍

根据还原点ID查询指定还原点

调用方法

请参见如何调用API。

URI

GET /v3/{project_id}/checkpoints/{checkpoint_id}

表1 路径参数

参数

是否必选

参数类型

描述

checkpoint_id

是

String

还原点ID

project_id

是

String

项目ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

否

String

用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

checkpoint

CheckpointCreate object

还原点信息
表4 CheckpointCreate

参数

参数类型

描述

created_at

String

创建时间，例如:"2020-02-05T10:38:34.209782"

id

String

还原点ID

project_id

String

项目ID

status

String

状态

  • available: 可用

  • deleting: 删除中

  • protecting: 保护中

  • deleted: 已删除

  • error-deleting:删除异常

  • error: 异常

vault

CheckpointPlanCreate object

存储库信息

extra_info

CheckpointExtraInfoResp object

扩展信息
表5 CheckpointPlanCreate

参数

参数类型

描述

id

String

存储库id

name

String

存储库名称

resources

Array of CheckpointResourceResp objects

备份对象

skipped_resources

Array of CheckpointCreateSkippedResource objects

备份时跳过的资源列表
表6 CheckpointResourceResp

参数

参数类型

描述

extra_info

String

资源附加信息

id

String

待备份资源id

name

String

待备份资源名称

protect_status

String

保护状态

  • available: 可用

  • error: 异常

  • protecting: 保护中

  • restoring: 恢复中

  • removing: 删除中

resource_size

String

资源已分配容量,单位为GB

type

String

待备份资源的类型: OS::Nova::Server, OS::Cinder::Volume, OS::Ironic::BareMetalServer, OS::Native::Server, OS::Sfs::Turbo, OS::Workspace::DesktopV2

backup_size

String

副本大小

backup_count

String

副本数量
表7 CheckpointCreateSkippedResource

参数

参数类型

描述

id

String

资源ID

type

String

资源类型

name

String

资源名称

code

String

请参见错误码。

reason

String

跳过原因，例如：该资源正在备份中。
表8 CheckpointExtraInfoResp

参数

参数类型

描述

name

String

备份名称

description

String

备份描述

retention_duration

Integer

备份保留天数

请求示例

GET https://{endpoint}/v3/4229d7a45436489f8c3dc2b1d35d4987/checkpoints/8b0851a8-adf3-4f4c-a914-dead08bf9664

响应示例

状态码： 200

OK

{
  "checkpoint" : {
    "status" : "available",
    "created_at" : "2019-05-10T07:59:12.037+00:00",
    "vault" : {
      "id" : "3b5816b5-f29c-4172-9d9a-76c719a659ce",
      "resources" : [ {
        "name" : "ecs-1f0f-0002",
        "resource_size" : 40,
        "protect_status" : "available",
        "type" : "OS::Nova::Server",
        "id" : "94eba8b2-acc9-4d82-badc-127144cc5526"
      } ],
      "name" : "vault-be94"
    },
    "project_id" : "4229d7a45436489f8c3dc2b1d35d4987",
    "id" : "8b0851a8-adf3-4f4c-a914-dead08bf9664"
  }
}

状态码

状态码

描述

200

OK

错误码

请参见错误码。

父主题： 还原点