Domain name for API request: cbs.intl.tencentcloudapi.com.
This API is used to replicate snapshots across regions.
This API is asynchronous. When the cross-region replication request is issued successfully, it returns a new snapshot ID. At this point, the snapshot is not immediately replicated to the target region. You can use the DescribeSnapshots API for the query in the target region to check the snapshot status and determine whether the replication is complete. If the snapshot status is "NORMAL", it indicates snapshot replication is complete.
This API is used to perform snapshot cross-region replication, which will generate cross-region traffic. Commercial billing for this feature is expected in Q3 2025. Please check subsequent Message Center notices to avoid unexpected charges.
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: CopySnapshotCrossRegions. |
| Version | Yes | String | Common Params. The value used for this API: 2017-03-12. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| DestinationRegions.N | Yes | Array of String | Destination regions of the replication task. You can query the value of regions by calling DescribeRegions API. Note that you can only specify regions that support snapshots. |
| SnapshotId | No | String | Snapshot ID, which can be queried via the DescribeSnapshots API. |
| SnapshotName | No | String | Name of the snapshot replica. If it is not specified, it defaults to Copied [source snapshot ID from [region name] |
| Parameter Name | Type | Description |
|---|---|---|
| SnapshotCopyResultSet | Array of SnapshotCopyResult | Result of the cross-region replication task. The ID of the new snapshot replica is returned if the request succeeds. Otherwise Error is returned. |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
This example shows you how to replicate a snapshot from Guangzhou to Beijing.
POST / HTTP/1.1
Host: cbs.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CopySnapshotCrossRegions
<Common request parameters>
{
"SnapshotId": "snap-ckgjwkqh",
"DestinationRegions": [
"ap-beijing"
]
}
{
"Response": {
"SnapshotCopyResultSet": [
{
"SnapshotId": "snap-d012rm6t",
"DestinationRegion": "ap-beijing",
"Code": "Success",
"Message": ""
}
],
"RequestId": "98f0b5f0-7d84-4d11-9819-ee7804e524a4"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| InsufficientSnapshotQuota | Insufficient snapshot quota. |
| InternalError.ComponentError | Dependent component request failed. Please contact customer service. |
| InvalidAccount.InsufficientBalance | Insufficient account balance |
| InvalidParameterValue | Invalid parameter value. |
| InvalidSnapshot.NotSupported | Indicates that the operation is not supported for the snapshot. |
| InvalidSnapshotId.NotFound | The ‘SnapshotId’ entered does not exist. |
| ResourceBusy | The resource is busy. Try again later. |
| ResourceInUse.CopySnapshotConflict | The specified snapshot is being replicated to the destination region. |
| UnsupportedOperation.SnapshotNotSupportCopy | The snapshot does not support cross-region replication. |
フィードバック