Replicate a custom image across regions
Updated at:2025-10-20
This API allows users to replicate custom images across regions. Only custom images can be replicated, excluding public and service integration images.
- If the image ID specified in imageId does not exist, a 404 error is returned.
- After a successful image replication, users can use this image in the destination region to create or reset instances.
Request structure
Plain Text
1POST /v{version}/image/{imageId}?{action} HTTP/1.1
2Host: bcc.bj.baidubce.com
3Authorization: authorization string
4
5{
6 "name" : "destImageName",
7 "destRegion" : ["bj","gz"]
8}
Request headers
There are no special headers required beyond the common headers.
Request parameters
| Parameter name | Types | Whether required | Parameter location | Description |
|---|---|---|---|---|
| version | String | Yes | URL parameter | API version number |
| imageId | String | Yes | URL parameter | ID of the image to be replicated |
| action | String | Yes | Query | Action performed on the image, current value: remoteCopy |
| name | String | No | Request Body parameters | Name of the replicated image |
| destRegion | Yes | Request Body parameters | Destination regionId; multiple values can be specified |
Response headers
No special headers are required beyond the standard ones.
Response parameters
| Parameter name | Types | Description |
|---|---|---|
| result | Remote replication result |
Error codes
| Error code | Error description | HTTP status code | Chinese explanation |
|---|---|---|---|
| Image.RegionNotSupportCopy | Region not support copy. | 409 | The destination region does not support replication |
| Image.ImageStorageFormatInvalid | Image storage format is invalid. | 409 | The image storage format does not support replication |
| Image.ImageNotSupportCopy | Image not support copy. | 409 | Non-custom images cannot be replicated |
| Image.ImageStatusForbidden | Image status is not Available. | 409 | The image status is unavailable |
Request example
Plain Text
1POST /v2/image/m-nky7qeom?remoteCopy HTTP/1.1
2Host: bcc.bj.baidubce.com
3ContentType: application/json
4Date: Wed, 01 Mar 2006 12:00:00 GMT
5Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
6
7{
8 "name": "test-copy-image",
9 "destRegion": ["bj","gz"]
10}
Response example
Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
3Date: Wed, 03 Dec 2014 06:42:19 GMT
4Content-Type: application/json;charset=UTF-8
5Server: BWS
6
7{
8 "result": [
9 {
10 "region": "gz",
11 "imageId": "m-3ev9sySj",
12 "errMsg": "success",
13 "code": "success"
14 },
15 {
16 "region": "bj",
17 "imageId": "m-3ev9sySj",
18 "errMsg": "success",
19 "code": "success"
20 }
21 ]
22}
