文档首页/ 云备份 CBR/ API参考/ API/ 还原点/ 查询备份还原点 - ShowCheckpoint
更新时间:2026-10-20 GMT+08:00
分享

查询备份还原点 - ShowCheckpoint

功能介绍

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

授权信息

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

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

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

checkpoint_id

是

String

参数解释:

还原点ID

[获取方法请参见查询所有备份。]

约束限制:

不涉及

取值范围:

格式为UUID

默认取值:

不涉及

project_id

是

String

参数解释:

项目ID,用于标识用户所属项目,以便进行项目级别的资源隔离和管理。

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

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

否

String

参数解释:

用户Token。用于鉴权验证,确认调用者身份和权限。

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

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

checkpoint

CheckpointCreate object

参数解释:

创建备份后返回的还原点信息,包含还原点ID、状态、关联存储库等。

取值范围:

不涉及

表4 CheckpointCreate

参数

参数类型

描述

created_at

String

参数解释:

创建时间,使用UTC+0时间,格式为yyyy-MM-ddTHH:mm:ss.SSSSSS。

取值范围:

不涉及

id

String

参数解释:

还原点ID。

取值范围:

格式为UUID

project_id

String

参数解释:

项目ID。

取值范围:

不涉及

status

String

参数解释:

还原点状态

取值范围:

  • available: 可用

  • deleting: 删除中

  • protecting: 保护中

  • deleted: 已删除

  • error-deleting:删除异常

  • error: 异常

vault

CheckpointPlanCreate object

参数解释:

备份还原点关联的存储库信息,包含存储库ID、名称、备份资源等。

取值范围:

不涉及

extra_info

CheckpointExtraInfoResp object

参数解释:

备份还原点的扩展信息,包含备份名称、描述、保留天数等。

取值范围:

不涉及

表5 CheckpointPlanCreate

参数

参数类型

描述

id

String

参数解释:

存储库ID。

取值范围:

格式为UUID

name

String

参数解释:

存储库名称。

取值范围:

只能由中文、字母、数字、“_”、“-”组成,最大支持64个字符。

resources

Array of CheckpointResourceResp objects

参数解释:

存储库中备份资源的信息列表,列表元素为CheckpointResourceResp对象,包含资源ID、名称、类型、保护状态等。

取值范围:

不涉及

skipped_resources

Array of CheckpointCreateSkippedResource objects

参数解释:

备份时跳过的资源列表,列表元素为CheckpointCreateSkippedResource对象,包含跳过资源的ID、类型和原因等信息。

取值范围:

不涉及

表6 CheckpointResourceResp

参数

参数类型

描述

extra_info

String

参数解释:

资源附加信息。

取值范围:

不涉及

id

String

参数解释:

待备份资源ID。

取值范围:

格式为UUID

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

参数解释:

备份名称。

取值范围:

不涉及

description

String

参数解释:

备份描述

取值范围:

不涉及

retention_duration

Integer

参数解释:

备份保留天数,单位:天。

取值范围:

不涉及

请求示例

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

 

响应示例

状态码:200

{
  "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

错误码

请参见错误码。

相关文档