Querying a Restore Point
Function
This API is used to query a specified restore point based on its ID.
Debugging
You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.
URI
GET /v3/{project_id}/checkpoints/{checkpoint_id}
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
checkpoint_id |
Yes |
String |
Checkpoint ID. For details, see Creating a Checkpoint and Querying All Backups. |
project_id |
Yes |
String |
Project ID. For details about how to obtain the project ID, see Obtaining a Project ID. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
No |
String |
User token The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
checkpoint |
CheckpointCreate object |
Checkpoint information. |
Parameter |
Type |
Description |
---|---|---|
created_at |
String |
Creation time, for example, 2020-02-05T10:38:34.209782 |
id |
String |
Restore point ID |
project_id |
String |
Project ID |
status |
String |
Status |
vault |
CheckpointPlanCreate object |
Vault information |
extra_info |
CheckpointExtraInfoResp object |
Extended information |
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 |
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. For details about how to obtain the ID, see Querying Information About the Resources Associated with a Vault and Querying Protectable Resources. |
name |
String |
Name of the resource to be backed up. The value can contain a maximum of 255 characters. |
protect_status |
String |
Protected status |
resource_size |
String |
Allocated capacity for the associated resource, in GB |
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; OS::Workspace::DesktopV2: Workspaces |
backup_size |
String |
Backup replica size in GB. |
backup_count |
String |
Number of backups |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Resource ID |
type |
String |
Resource type. OS::Nova::Server: ECS; OS::Cinder::Volume: EVS disks; OS::Ironic::BareMetalServer: Bare Metal Servers; OS::Sfs::Turbo: SFS Turbo file systems; OS::Workspace::DesktopV2: Workspaces |
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. |
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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot