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 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.

**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 for backing up to a vault.
vault_id	Yes	String	Vault ID

**Table 5** CheckpointParam
Parameter	Mandatory	Type	Description
auto_trigger	No	Boolean	Whether the task is automatically triggered. Default value: false. true: The task is automatically triggered. false: The task is not automatically triggered.
description	No	String	Backup description
incremental	No	Boolean	Whether the backup is an incremental backup. Possible values are true (yes) and false (no).
name	No	String	Backup name. The value can contain a maximum of 64 characters, including digits, uppercase letters, lowercase letters, underscores (_), and hyphens (-).
resources	No	Array of strings	IDs of the resources to be backed up. The IDs are in UUID format. The resources must have been associated with the vault and can be backed up.
resource_details	No	Array of Resource objects	Details about the resources to be backed up.

**Table 6** Resource
Parameter	Mandatory	Type	Description
id	Yes	String	ID of the resource to be backed up. The resource must have been associated with the vault and can be backed up.
name	No	String	Name of the resource to be backed up. The value can contain a maximum of 255 characters.
type	Yes	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

Response Parameters

Status code: 200

**Table 7** Response body parameters
Parameter	Type	Description
checkpoint	CheckpointCreate object	Checkpoint information.

**Table 8** 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
vault	CheckpointPlanCreate object	Vault information
extra_info	CheckpointExtraInfoResp object	Extended information

**Table 9** 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 10** 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	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
backup_size	String	Backup replica size in GB.
backup_count	String	Number of backups

**Table 11** CheckpointCreateSkippedResource
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
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 12** 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

Automatically backing up a vault and generating a restore point

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

{
  "checkpoint" : {
    "status" : "protecting",
    "created_at" : "2019-05-10T07:59:12.733+00:00",
    "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"
    }
  }
}