Replicating a Backup
Function
This API is used to replicate a backup across regions.
Debugging
You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.
URI
POST /v3/{project_id}/backups/{backup_id}/replicate
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
backup_id |
Yes |
String |
ID of the backup to be replicated. For details about how to obtain the backup ID, see Obtaining a Backup ID. |
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
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 |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
replicate |
Yes |
BackupReplicateReqBody object |
Replication parameter |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
description |
No |
String |
Replication description. The value cannot contain angle brackets (< or >) and can contain a maximum of 255 characters. Default value: N/A |
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 |
Target 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. |
name |
No |
String |
Replica name. It can contain a maximum of 64 characters, including only letters, digits, underscores (_), and hyphens (-). Default value: N/A |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
replication |
BackupReplicateRespBody object |
Replication response parameter |
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. |
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 the replication is executed. Range: N/A |
provider_id |
String |
Resource type ID. Range: N/A |
replication_record_id |
String |
Replication record ID. Range: N/A |
source_region |
String |
Source region. For details about how to obtain the region, see Querying Regions and Endpoints. |
Example Requests
Replicating a backup from the source vault to the destination vault
POST https://{endpoint}/v3/f841e01fd2b14e7fa41b6ae7aa6b0594/backups/a5200268-74a5-4806-acc6-95793ab0228b/replicate { "replicate" : { "description" : "backup_description", "destination_project_id" : "68589cac08274b82b4e254268a3862d8", "destination_region" : "region2", "destination_vault_id" : "0ca3eb86-8800-46da-9c37-9d657a825274", "enable_acceleration" : false, "name" : "backup_name" } }
Example Responses
Status code: 200
OK
{ "replication" : { "destination_vault_id" : "0ca3eb86-8800-46da-9c37-9d657a825274", "provider_id" : "0daac4c5-6707-4851-97ba-169e36266b66", "backup_id" : "6df2b54c-dd62-4059-a07c-1b8f24f2725d", "destination_project_id" : "68589cac08274b82b4e254268a3862d8", "destination_region" : "region2", "source_region" : "region1", "project_id" : "4229d7a45436489f8c3dc2b1d35d4987", "replication_record_id" : "1579a71e-8d8d-41e6-85dc-d77f5ce8d91a" } }
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