Replicating a Restore Point

Function

This API is used to replicate a restore point.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

POST /v3/{project_id}/checkpoints/replicate

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. Default value: N/A For details about how to obtain the project ID, see Obtaining a Project ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	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

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
replicate	Yes	CheckpointReplicateParam object	Request body parameters for replicating a backup.

**Table 4** CheckpointReplicateParam
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.
destination_project_id	Yes	String	Project ID of the destination region. Default value: N/A For details about how to obtain the project ID, see Obtaining a Project ID.
destination_region	Yes	String	ID of the destination region. Default value: N/A For details about how to obtain the region ID, see Querying Regions and Endpoints.
destination_vault_id	Yes	String	ID of the vault in the destination region. Default value: N/A For details, see Obtaining a Vault ID, where project_id must be set to the project ID of the destination region.
enable_acceleration	No	Boolean	Whether to enable acceleration to shorten the cross-region replication time. If this parameter is not set, the acceleration function is disabled. If enabled, the acceleration function is additionally charged. true: The acceleration function is enabled. false: The acceleration function is disabled.
vault_id	Yes	String	Vault ID in UUID format. Default value: N/A For details about how to obtain the vault ID, see Obtaining a Vault ID.

Response Parameters

Status code: 200

**Table 5** Response body parameters
Parameter	Type	Description
replication	CheckpointReplicateRespBody object	Restore point replication objects in the response

**Table 6** CheckpointReplicateRespBody
Parameter	Type	Description
backups	Array of CheckpointReplicateRespbackups objects	List of backups to be replicated
destination_project_id	String	Destination project ID. For details, see Obtaining a Project ID and Querying Supported Regions.
destination_region	String	Destination region. For details about how to obtain the region ID, see Querying Regions and Endpoints.
destination_vault_id	String	ID of the vault in the destination region. For details, see Obtaining a Vault ID, where project_id must be set to the project ID of the destination region.
project_id	String	ID of the project where replication is performed
provider_id	String	Backup provider ID, which specifies whether the backup object is a server or disk
source_region	String	Source region. For details about how to obtain the region, see Querying Regions and Endpoints.
vault_id	String	Vault ID

**Table 7** CheckpointReplicateRespbackups
Parameter	Type	Description
backup_id	String	ID of the backup to be replicated. For details about how to obtain the backup ID, see Obtaining a Backup ID.
replication_record_id	String	Replication record ID

Example Requests

Manually replicating a backup from a source region to a destination region

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

{
  "replicate" : {
    "auto_trigger" : false,
    "destination_project_id" : "68589cac08274b82b4e254268a3862d8",
    "destination_region" : "region2",
    "destination_vault_id" : "0ca3eb86-8800-46da-9c37-9d657a825274",
    "enable_acceleration" : false,
    "vault_id" : "3b5816b5-f29c-4172-9d9a-76c719a659ce"
  }
}

Example Responses

Status code: 200

{
  "replication" : {
    "destination_vault_id" : "0ca3eb86-8800-46da-9c37-9d657a825274",
    "provider_id" : "0daac4c5-6707-4851-97ba-169e36266b66",
    "source_region" : "region1",
    "vault_id" : "3b5816b5-f29c-4172-9d9a-76c719a659ce",
    "destination_region" : "region2",
    "destination_project_id" : "68589cac08274b82b4e254268a3862d8",
    "backups" : [ {
      "replication_record_id" : "de128dfa-5451-4905-9c11-8fc842b2f41e",
      "backup_id" : "7558e1a3-7046-4787-95cd-14b0ad0642a8"
    }, {
      "replication_record_id" : "892a7d1e-17c8-4751-ad75-cfbed7051857",
      "backup_id" : "6df2b54c-dd62-4059-a07c-1b8f24f2725d"
    }, {
      "replication_record_id" : "8bf5ce8f-bfa1-4d57-98de-d6159ab9d86d",
      "backup_id" : "aa00034d-ef40-443d-ab7a-dc846d988cdf"
    } ],
    "project_id" : "4229d7a45436489f8c3dc2b1d35d4987"
  }
}