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.
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: SyncImages. |
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. |
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 requirement: NORMAL state. For more information on image status, see Image Data Table. |
DestinationRegions.N | Yes | Array of String | List of destination regions for synchronization. Limits: See Region. |
DryRun | No | Boolean | Checks whether image synchronization can be initiated. |
ImageName | No | String | Destination image name. |
ImageSetRequired | No | Boolean | Whether to return the ID of image created in the destination region |
Parameter Name | Type | Description |
---|---|---|
ImageSet | Array of SyncImage | ID of the image created in the destination region |
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 the image img-o3ycss2p
to Guangzhou.
POST / HTTP/1.1
Host: cvm.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: SyncImages
<Common request parameters>
{
"ImageIds": [
"img-o3ycss2p"
],
"DestinationRegions": [
"ap-guangzhou"
]
}
{
"Response": {
"RequestId": "71e69b56-32be-4412-ab45-49eded6a87be"
}
}
This example shows you how to sync the image img-o3ycss2p
to Guangzhou.
POST / HTTP/1.1
Host: cvm.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: SyncImages
<Common request parameters>
{
"ImageIds": [
"img-o3ycss2p"
],
"DestinationRegions": [
"ap-guangzhou"
],
"ImageSetRequired": true
}
{
"Response": {
"ImageSet": [
{
"Region": "ap-guangzhou",
"ImageId": "img-evhmf3fy"
}
],
"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 |
---|---|
FailedOperation.InvalidImageState | The image is busy. Please try again later. |
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. |
InvalidImageName.Duplicate | The specified image name already exists. |
InvalidParameter.InstanceImageNotSupport | This API does not support instance images. |
InvalidParameterValue.InvalidImageId | The image does not support this operation. |
InvalidParameterValue.InvalidImageState | The image has another ongoing task. Please check and try again later. |
InvalidParameterValue.InvalidRegion | The Region ID is unavailable. |
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.EncryptedImagesNotSupported | Encrypted images are not supported. |
UnsupportedOperation.LocationImageNotSupported | |
UnsupportedOperation.Region | The region is unsupported. |
Was this page helpful?