Help Center/ Cloud Backup and Recovery/ API Reference/ CBR APIs/ Restore Points/ Querying a Restore Point
Updated on 2025-10-24 GMT+08:00
View PDF

Querying a Restore Point

Function

This API is used to query a specified restore point based on its ID.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

checkpoint_id

Yes

String

Checkpoint ID.

project_id

Yes

String

Project ID. Default value: N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

No

String

User token. You can obtain it by calling the IAM API for obtaining a user token. The user token is the value of X-Subject-Token in the response header. Default value: N/A

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

checkpoint

CheckpointCreate object

Checkpoint information.
Table 4 CheckpointCreate

Parameter

Type

Description

created_at

String

Creation time, for example, 2020-02-05T10:38:34.209782.

id

String

Checkpoint ID.

project_id

String

Project ID.

status

String

Checkpoint status. The value can be:

  • available: The checkpoint is available.

  • deleting: The checkpoint is being deleted.

  • protecting: The checkpoint is being protected.

  • deleted: The checkpoint has been deleted.

  • error-deleting: An exception occurred during the deletion.

  • error: The checkpoint is abnormal.

vault

CheckpointPlanCreate object

Vault information

extra_info

CheckpointExtraInfoResp object

Extended information
Table 5 CheckpointPlanCreate

Parameter

Type

Description

id

String

Vault ID.

name

String

Vault name. The value can contain a maximum of 64 characters, including letters, digits, underscores (_), and hyphens (-).

resources

Array of CheckpointResourceResp objects

Backup objects

skipped_resources

Array of CheckpointCreateSkippedResource objects

Resources skipped during backup
Table 6 CheckpointResourceResp

Parameter

Type

Description

extra_info

String

Extra information of the resource

id

String

ID of the resource to be backed up. The resource must have been associated with the vault and can be backed up.

name

String

Name of the resource to be backed up. The value can contain a maximum of 255 characters.

protect_status

String

Protection status. The value can be:

  • available: The resource is available.

  • error: The resource is abnormal.

  • protecting: The resource is being protected.

  • restoring: The resource is being restored.

  • removing: The resource is being removed.

resource_size

String

Allocated capacity for the associated resources, in GB Range: N/A

type

String

Type of the resource to be backed up: OS::Nova::Server: ECS; OS::Cinder::Volume: EVS disks; OS::Ironic::BareMetalServer: Bare Metal Servers; OS::Sfs::Turbo: SFS Turbo file systems Default value: N/A

backup_size

String

Backup replica size in GB. Range: N/A; Default value: N/A

backup_count

String

Number of replicas. Range: N/A; Default value: N/A
Table 7 CheckpointCreateSkippedResource

Parameter

Type

Description

id

String

Resource ID, in UUID format. You can query the resource ID based on the type of the resource to be backed up.

type

String

Resource type. The value can be:

name

String

Name of the resource to be backed up. The value can contain a maximum of 255 characters.

code

String

For details, see Error Codes.

reason

String

Reason for the skipping. For example, the resource is being backed up.
Table 8 CheckpointExtraInfoResp

Parameter

Type

Description

name

String

Backup name. The value can contain a maximum of 64 characters, including digits, uppercase letters, lowercase letters, underscores (_), and hyphens (-).

description

String

Backup description. Range: N/A

retention_duration

Integer

Number of days for storing backups. Range: N/A

Example Requests

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

Example Responses

Status code: 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"
  }
}

Status Codes

Status Code

Description

200

OK

Error Codes

See Error Codes.

Parent topic: Restore Points