Function

This API is used to replicate a backup. You cannot replicate a backup if the backup has one replica in or is being replicated to the destination region.

URI

• URI format

  POST https://{endpoint}/v1/{project_id}/providers/{provider_id}/checkpoint_items/{checkpoint_item_id}/replicate

• Parameter description

  Parameter	Mandatory	Type	Description
  project_id	Yes	String	Project ID For details about how to obtain the project ID, see Obtaining a Project ID.
  provider_id	Yes	String	Backup provider ID, which specifies whether the backup object is a server or disk. This parameter has a fixed value. For CSBS, the value is fc4d5750-22e7-4798-8a46-f48f62c4c1da.
  checkpoint_item_id	Yes	String	ID of the source backup used for replication

Request

• Element description

  Parameter	Mandatory	Type	Description
  replication	Yes	replication_param	Replication parameter

• Parameter description of field replication_param

  Parameter	Mandatory	Type	Description
  name	No	String	Replica name
  description	No	String	Replica description
  destination_region	Yes	String	Destination region of the replication, which can be obtained by calling the API of Querying the Replication Capability.
  destination_project_id	Yes	String	ID of the replication destination project
  enable_acceleration	No	Boolean	Whether to enable the acceleration function to shorten the replication time for cross-region replication. If this parameter is not set, the acceleration function is disabled.

• Example request

  POST https://{endpoint}/v1/{project_id}/providers/{provider_id}/checkpoint_items/{checkpoint_item_id}/replicate
  {
    "replication" : {
      "destination_region": "cn-east-2",
      "destination_project_id": "e0b97bac-532c-4c51-96fa-4b3a32253be4",
      "name": "rep_from_bd3c8a42-7dd4-4400-b091-2777c51a5c9a",
      "description": "do replication"
    }
  }

Response

• Element description

  Parameter	Type	Description
  replication	replication_resp	Replication response parameter

• Parameter description of field replication_resp

  Parameter	Type	Description
  project_id	String	Project ID
  provider_id	String	Backup provider ID, which specifies whether the backup object is a server or disk. This parameter has a fixed value. For CSBS, the value is fc4d5750-22e7-4798-8a46-f48f62c4c1da.
  checkpoint_item_id	String	ID of the source backup used for replication
  source_region	String	Replication source region
  destination_region	String	ID of the replication destination region
  destination_project_id	String	ID of the replication destination project
  replication_record_id	String	Replication record ID

• Example response

  {
    "replication" :{
        "project_id": "4800fde9-66f8-4458-b805-4c01066b9568",
        "provider_id": "fc4d5750-22e7-4798-8a46-f48f62c4c1da",
        "checkpoint_item_id": "c4dfa74c-7e60-4361-86b9-9a3250115ed6",
        "source_region": "cn-north-1",
        "destination_region": "cn-east-2",
        "destination_project_id": "e0b97bac-532c-4c51-96fa-4b3a32253be4",
        "replication_record_id": "042cd047-a7c9-4905-a859-402950ac8440"
    } 
  }

Status Codes

• Normal

  Status Code	Description
  200	OK

• Abnormal

  Status Code	Description
  400	Invalid request parameters.
  401	Authentication failed.
  403	No operation permission.
  404	Requested object not found.
  500	Service internal error.
  503	Service unavailable.

Error Codes

For details, see Error Codes.