Domain name for API request: cvm.tencentcloudapi.com.
This API is used to sync a custom image to other regions.
A maximum of 10 requests can be initiated per second for this API.
Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: cvm.ap-shanghai-fsi.tencentcloudapi.com
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 parameter. The value used for this API: SyncImages. |
| Version | Yes | String | Common parameter. The value used for this API: 2017-03-12. |
| Region | Yes | String | Common parameter. For more information, please see the list of regions supported by the product. |
| ImageIds.N | Yes | Array of String | List of image IDs. You can obtain the image IDs in two ways: ImageId in the response. The specified images must meet the following requirements: NORMAL state. For more information on image states, see here. |
| DestinationRegions.N | Yes | Array of String | List of destination regions for synchronization. A destination region must meet the following requirements: For specific regions, see Region. |
| Parameter Name | Type | Description |
|---|---|---|
| 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 sync an image img-o3ycss2p to the Guangzhou region.
GET https://cvm.tencentcloudapi.com/?Action=SyncImages
&ImageIds.0=img-o3ycss2p
&DestinationRegions.0=ap-guangzhou
&<Common request parameters>{
"Response": {
"RequestId": "71e69b56-32be-4412-ab45-49eded6a87be"
}
}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 |
|---|---|
| ImageQuotaLimitExceeded | The image quota has been exceeded. |
| InvalidImageId.IncorrectState | Invalid image status. |
| InvalidImageId.Malformed | Invalid image ID format. |
| InvalidImageId.NotFound | The image cannot be found. |
| InvalidImageId.TooLarge | The image size exceeds the limit. |
| InvalidParameter.InstanceImageNotSupport | This API does not support instance images. |
| InvalidParameterValue.InvalidImageId | The image does not support this operation. |
| InvalidParameterValue.InvalidImageState | Invalid image status. |
| InvalidParameterValue.LimitExceeded | The number of parameter values exceeds the limit. |
| InvalidRegion.NotFound | The region cannot be found. |
| InvalidRegion.Unavailable | Currently this region does not support image synchronization. |
| UnsupportedOperation.Region | The region is unsupported. |
Was this page helpful?