文档首页/ 云备份 CBR/ API参考/ API/ 还原点/ 查询备份还原点 - ShowCheckpoint
更新时间：2025-11-03 GMT+08:00
查看PDF
分享

查询备份还原点 - ShowCheckpoint

功能介绍

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

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，当前API调用无需身份策略权限。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

checkpoint_id

是

String

还原点ID

获取方法请参见"创建备份还原点", "查询所有备份"。

project_id

是

String

项目ID，默认取值不涉及。

获取方法请参见"获取项目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。

获取方法请参见"获取项目ID"。

status

String

还原点状态，取值范围如下：

  • available: 可用

  • deleting: 删除中

  • protecting: 保护中

  • deleted: 已删除

  • error-deleting:删除异常

  • error: 异常

vault

CheckpointPlanCreate object

存储库信息

extra_info

CheckpointExtraInfoResp object

扩展信息
表5 CheckpointPlanCreate

参数

参数类型

描述

id

String

存储库ID。

获取方法请参见"获取存储库ID"。

name

String

存储库名称，最大支持64字符，只能由中文、字母、数字、“_”、“-”组成。

resources

Array of CheckpointResourceResp objects

备份对象

skipped_resources

Array of CheckpointCreateSkippedResource objects

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

参数

参数类型

描述

extra_info

String

资源附加信息

id

String

待备份资源id，需要该资源已经绑定到该存储库中，且属于可备份的状态。

获取方法请参见"查询存储库绑定资源信息"，"查询资源可保护性"。

name

String

待备份资源名称，长度限制：0-255字符。

protect_status

String

保护状态，取值范围如下：

  • available: 可用

  • error: 异常

  • protecting: 保护中

  • restoring: 恢复中

  • removing: 删除中

resource_size

String

资源已分配容量，单位为GB。取值范围不涉及。

type

String

待备份资源的类型: OS::Nova::Server：云服务器； OS::Cinder::Volume：云硬盘；OS::Ironic::BareMetalServer：裸金属服务器；OS::Sfs::Turbo：SFS Turbo文件系统；OS::Workspace::DesktopV2：云桌面。默认取值不涉及。

backup_size

String

备份副本大小。单位GB。取值范围不涉及，默认取值不涉及。

backup_count

String

副本数量，取值范围不涉及，默认取值不涉及。
表7 CheckpointCreateSkippedResource

参数

参数类型

描述

id

String

资源ID，格式为UUID。可根据待备份的资源类型查询对应的资源情况。

type

String

资源类型，取值范围如下：

OS::Nova::Server：云服务器；OS::Cinder::Volume：云硬盘；OS::Ironic::BareMetalServer：裸金属服务器；OS::Sfs::Turbo：SFS Turbo文件系统；OS::Workspace::DesktopV2：云桌面

name

String

待备份资源名称，长度限制：0-255字符。

code

String

请参见错误码。

reason

String

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

参数

参数类型

描述

name

String

备份名称，最大支持64字符，只能由数字、中文、英文大小写字母，以及下划线"_"和中横线 "-" 字符构成。

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

错误码

请参见错误码。

父主题： 还原点