产品动态
公共镜像更新动态
操作系统官方停止维护计划
产品公告
Domain name for API request: cvm.intl.tencentcloudapi.com.
This API is used to synchronize custom images 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 | Yes | String | Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-bangkok, ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-jakarta, ap-nanjing, ap-seoul, ap-shanghai, ap-shanghai-fsi, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley, sa-saopaulo. |
| ImageIds.N | Yes | Array of String | Image ID list. You can obtain the image IDs in the following ways:ImageId in the response.The image IDs should meet the following requirement: NORMAL state. |
| DestinationRegions.N | Yes | Array of String | List of target synchronization regions, which should meet the following requirements: |
| DryRun | No | Boolean | Checks whether image synchronization can be initiated. Default value: false. |
| ImageName | No | String | Target image name. By default, the source image name is used. |
| ImageSetRequired | No | Boolean | Whether to return the ID of the image created in the target region. Default value: false. |
| Encrypt | No | Boolean | Whether to synchronize as an encrypted custom image. Default value is false.Synchronization to an encrypted custom image is only supported within the same region. |
| KmsKeyId | No | String | KMS key ID used when synchronizing to an encrypted custom image. This parameter is valid only synchronizing to an encrypted image. If KmsKeyId is not specified, the default CBS cloud product KMS key is used. |
| Parameter Name | Type | Description |
|---|---|---|
| ImageSet | Array of SyncImage | ID of the image created in the destination region |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
This example shows you how to synchronize the image img-o3ycss2p to Guangzhou.
POST / HTTP/1.1
Host: cvm.intl.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 synchronize the image img-o3ycss2p to Guangzhou.
POST / HTTP/1.1
Host: cvm.intl.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. |
| InvalidParameter.InvalidKmsKeyId | The specified KMS key ID is invalid. |
| 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 | This request does not support images in this region. Please change to another image. |
| UnsupportedOperation.Region | The region is unsupported. |
| UnsupportedOperation.SyncEncryptImageNotSupport | The specified image does not support synchronization to an encrypted custom image. |
文档反馈