Help Center> Cloud Backup and Recovery> API Reference> CBR APIs> Restore Points> Creating a Restore Point
View PDF

Creating a Restore Point

Function

This API is used to back up a vault and generate a restore point.

URI

POST /v3/{project_id}/checkpoints

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

Obtained by calling the corresponding IAM API. If the request is successfully processed, the value of X-Subject-Token included in the response header is the token value.
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

checkpoint

Yes

VaultBackup object

Parameters for backing up the vault
Table 4 VaultBackup

Parameter

Mandatory

Type

Description

parameters

No

CheckpointParam object

Parameters

vault_id

Yes

String

Vault ID
Table 5 CheckpointParam

Parameter

Mandatory

Type

Description

auto_trigger

No

Boolean

Whether automatic triggering is enabled. Possible values are true (yes) and false (no).

Default: false

description

No

String

Backup description

Minimum: 0

Maximum: 255

incremental

No

Boolean

Whether the backup is an incremental backup. Possible values are true (yes) and false (no).

Default: true

name

No

String

Backup name

Minimum: 1

Maximum: 64

resources

No

Array of strings

UUID list of resources to be backed up

resource_details

No

Array of Resource objects
Table 6 Resource

Parameter

Mandatory

Type

Description

extra_info

No

ResourceExtraInfo object

Extra information of the resource

id

Yes

String

ID of the resource to be backed up

name

Yes

String

Name of the resource to be backed up. The value consists of 0 to 255 characters.

Minimum: 0

Maximum: 255

type

Yes

String

Type of the resource to be backed up. Possible values are as follows: OS::Nova::Server, OS::Cinder::Volume, OS::Ironic::BareMetalServer, OS::Native::Server, and OS::Sfs::Turbo
Table 7 ResourceExtraInfo

Parameter

Mandatory

Type

Description

exclude_volumes

No

Array of strings

ID of the disk that is excluded from the backup. This parameter is used only when there are VM disk backups.

include_volumes

No

Array of ResourceExtraInfoIncludeVolumes objects

Disk to be backed up
Table 8 ResourceExtraInfoIncludeVolumes

Parameter

Mandatory

Type

Description

id

Yes

String

EVS disk ID. Only UUID is supported.

os_version

No

String

OS type

Response Parameters

Status code: 200

Table 9 Response body parameters

Parameter

Type

Description

checkpoint

CheckpointCreate object

Restore point information
Table 10 CheckpointCreate

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

Enumeration values:

  • available

  • deleting

  • creating

  • restoring

  • error

vault

CheckpointPlanCreate object

Vault information

extra_info

CheckpointExtraInfoResp object
Table 11 CheckpointPlanCreate

Parameter

Type

Description

id

String

Vault ID

name

String

Vault name

resources

Array of CheckpointResourceResp objects

Backup objects

skipped_resources

Array of CheckpointCreateSkippedResource objects

Resources skipped during backup
Table 12 CheckpointResourceResp

Parameter

Type

Description

extra_info

String

Extra information of the resource

id

String

ID of the resource to be backed up

name

String

Name of the resource to be backed up

Minimum: 0

Maximum: 255

protect_status

String

Protection status

Enumeration values:

  • available

  • error

  • protecting

  • restoring

  • removing

resource_size

String

Allocated capacity for the associated resource, in GB

type

String

Type of the resource to be backed up. Possible values are as follows: OS::Nova::Server, OS::Cinder::Volume, OS::Ironic::BareMetalServer, OS::Native::Server, and OS::Sfs::Turbo

backup_size

String

Backup size

backup_count

String

Number of backups
Table 13 CheckpointCreateSkippedResource

Parameter

Type

Description

id

String

Resource ID

type

String

Resource type

name

String

Resource name

code

String

For details, see Error Codes.

reason

String

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

Parameter

Type

Description

name

String

Backup name

description

String

Backup description

retention_duration

Integer

Number of days that backups can be retained

Example Requests

POST https://{endpoint}/v3/{f841e01fd2b14e7fa41b6ae7aa6b0594}/checkpoints

{
  "checkpoint" : {
    "parameters" : {
      "auto_trigger" : true,
      "description" : "backup_description",
      "incremental" : true,
      "name" : "backup_name",
      "resources" : [ "94eba8b2-acc9-4d82-badc-127144cc5526" ]
    },
    "vault_id" : "3b5816b5-f29c-4172-9d9a-76c719a659ce"
  }
}

Example Responses

Status code: 200

The checkpoint information returned after performing the backup

{
  "checkpoint" : {
    "status" : "protecting",
    "created_at" : "2019-05-10T07:59:12.733403",
    "vault" : {
      "skipped_resources" : [ ],
      "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",
    "extra_info" : {
      "retention_duration" : -1,
      "name" : "backup_name",
      "description" : "backup_description"
    }
  }
}

Status Codes

Status Code

Description

200

The checkpoint information returned after performing the backup

Error Codes

See Error Codes.

Parent topic: Restore Points