Domain name for API request: cbs.tencentcloudapi.com.
This API is used to replicate a snapshot to another region.
NORMAL
, the snapshot is replicated successfully.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 | No | String | Common Params. This parameter is not required for this API. |
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’s 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, which is returned for each request. 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.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. |
Was this page helpful?