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.
URI
POST /v3/{project_id}/checkpoints/replicate
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID |
Request 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. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
replicate |
Yes |
CheckpointReplicateParam object |
Parameters in the request body of performing a replication |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
auto_trigger |
No |
Boolean |
Whether to automatically trigger replication this time. The default value is false, indicating the replication needs to be manually triggered. |
destination_project_id |
Yes |
String |
ID of the replication destination project |
destination_region |
Yes |
String |
ID of the replication destination region Minimum: 0 Maximum: 255 |
destination_vault_id |
Yes |
String |
ID of the vault in the replication destination region |
enable_acceleration |
No |
Boolean |
Whether to enable the acceleration function to shorten the time spent on cross-region replication. |
vault_id |
Yes |
String |
Vault ID (UUID) |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
replication |
CheckpointReplicateRespBody object |
Restore point replication objects in the response |
Parameter |
Type |
Description |
---|---|---|
backups |
Array of CheckpointReplicateRespbackups objects |
List of backups to be replicated |
destination_project_id |
String |
ID of the replication destination project |
destination_region |
String |
Replication destination region |
destination_vault_id |
String |
ID of the vault in the replication 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 |
Replication source region |
vault_id |
String |
Vault 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
OK
{ "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" } }
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