1. Interface Description
Interface request domain name: cbs.api3.convergecloud.com.
This API is used to replicate a snapshot across regions.
- This API is asynchronous. When a request for cross-region replication is successfully issued, a new snapshot ID is returned, but the snapshot is not immediately replicated to the target region. The status of the new snapshot in the target region can be queried through the DescribeSnapshots API to determine whether the replication is completed. If the snapshot status is NORMAL, it indicates that the snapshot is replicated successfully.
Default interface request rate limit: 20 times per second.
Interface update time: 2025-05-06 18:49:18.
The interface only verifies the signature but does not authenticate.
2. Input Parameters
The following list of request parameters only lists interface request parameters and some public parameters, For a complete list of public parameters see public request parameters.
| Parameter name | Required | Allow NULL | Type | Description |
|---|---|---|---|---|
| Action | Yes | No | String | Public parameter, The value of this interface: CopySnapshotCrossRegions |
| Version | Yes | No | String | Public parameter, The value of this interface: 2017-03-12 |
| Region | No | No | String | Public parameter,Regional information A list of supported geographies is available through the DescribeRegions interface |
| SnapshotId | No | No | String | ID of the source snapshot that requires cross-region replication. It can be queried through the DescribeSnapshots API. Example: snap-ckgjwkqh |
| DestinationRegions | Yes | No | Array of String | Target region to which the snapshot will be replicated. The standard values for each region can be queried through the DescribeRegions API. The input region should support snapshots. Example: ["region1"] |
| SnapshotName | No | No | String | Name of the new copied snapshot. If this parameter is not input, the default value is "Copied snap-11112222 from region name". Example: snap-hfdadhusads |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| SnapshotCopyResultSet | Array of SnapshotCopyResult | Result of snapshot cross-region replication. If the request is successfully issued, the new snapshot ID of the corresponding region will be returned; otherwise, Error is returned. Example:View |
| RequestId | String | Unique request id, Each request will return. The RequestId of the request needs to be provided when locating the problem. |
4. Error Code
The following lists only the error codes related to the interface business logic, For other error codes, see public ErrorCode.
| Error Code | Description |
|---|---|
| InvalidAccount.InsufficientBalance | Insufficient account balance |
| InsufficientSnapshotQuota | The snapshot quota is insufficient. |
| InvalidSnapshotId.NotFound | The input SnapshotId does not exist. |
| InvalidSnapshot.NotSupported | The snapshot does not support this operation. |