1. 接口描述
接口请求域名： cvm.tencentcloudapi.com 。
本接口（SyncImages）用于将自定义镜像同步到其它地区。
- 该接口每次调用只支持同步一个镜像。
- 该接口支持多个同步地域。
- 单个账号在每个地域最多支持存在500个自定义镜像。
默认接口请求频率限制：10次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：SyncImages。 |
| Version | 是 | String | 公共参数，本接口取值：2017-03-12。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| ImageIds.N | 是 | Array of String | 镜像ID列表 ，镜像ID可以通过如下方式获取：ImageId获取。镜像ID必须满足限制： NORMAL。示例值：["img-o3ycss2p"] |
| DestinationRegions.N | 是 | Array of String | 目的同步地域列表，必须满足如下限制： 示例值：["ap-guangzhou"] |
| DryRun | 否 | Boolean | 检测是否支持发起同步镜像。 默认值: false 示例值：false |
| ImageName | 否 | String | 目标镜像名称。默认使用源镜像名称。 示例值：“test_image” |
| ImageSetRequired | 否 | Boolean | 是否需要返回目的地域的镜像ID。 默认值: false 示例值：false |
| Encrypt | 否 | Boolean | 是否复制为加密自定义镜像。 默认值为 false。 复制加密自定义镜像仅支持同地域。 示例值：false |
| KmsKeyId | 否 | String | 加密自定义镜像使用的 KMS 密钥 ID。 仅当复制加密镜像时，即 Encrypt 为 true 时，此参数有效； 不指定 KmsKeyId，默认使用 CBS 云产品 KMS 密钥。 示例值：2bb53791-c2e9-4c42-8772-ecf135a1d92x |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ImageSet | Array of SyncImage | 目的地域的镜像ID信息。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 同步镜像
同步镜像img-o3ycss2p到广州
输入示例
POST / HTTP/1.1
Host: cvm.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: SyncImages
<公共请求参数>
{
"ImageIds": [
"img-o3ycss2p"
],
"DestinationRegions": [
"ap-guangzhou"
]
}输出示例
{
"Response": {
"ImageSet": [],
"RequestId": "71e69b56-32be-4412-ab45-49eded6a87be"
}
}示例2 同步镜像，同时需要返回目的地域的镜像ID
同步镜像img-o3ycss2p到广州
输入示例
POST / HTTP/1.1
Host: cvm.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: SyncImages
<公共请求参数>
{
"ImageIds": [
"img-o3ycss2p"
],
"DestinationRegions": [
"ap-guangzhou"
],
"ImageSetRequired": true
}输出示例
{
"Response": {
"ImageSet": [
{
"Region": "ap-guangzhou",
"ImageId": "img-evhmf3fy"
}
],
"RequestId": "71e69b56-32be-4412-ab45-49eded6a87be"
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.InvalidImageState | 镜像状态繁忙，请稍后重试。 |
| ImageQuotaLimitExceeded | 镜像配额超过了限制。 |
| InvalidImageId.IncorrectState | 镜像状态不合法。 |
| InvalidImageId.Malformed | 错误的镜像Id格式。 |
| InvalidImageId.NotFound | 未找到该镜像。 |
| InvalidImageId.TooLarge | 镜像大小超过限制。 |
| InvalidImageName.Duplicate | 镜像名称与原有镜像重复。 |
| InvalidParameter.InstanceImageNotSupport | 当前接口不支持实例镜像。 |
| InvalidParameter.InvalidKmsKeyId | 指定的 KMS 密钥 ID 非法。 |
| InvalidParameterValue.InvalidImageId | 镜像不允许执行该操作 |
| InvalidParameterValue.InvalidImageState | 镜像被其他操作占用，请检查，并稍后重试。 |
| InvalidParameterValue.InvalidRegion | Region ID不可用。 |
| InvalidParameterValue.LimitExceeded | 参数值数量超过限制。 |
| InvalidRegion.NotFound | 未找到该区域。 |
| InvalidRegion.Unavailable | 该区域目前不支持同步镜像。 |
| UnsupportedOperation.EncryptedImagesNotSupported | 不支持加密镜像。 |
| UnsupportedOperation.LocationImageNotSupported | 此请求不支持该区域镜像,请更换其他镜像。 |
| UnsupportedOperation.Region | 不支持该地域 |
| UnsupportedOperation.SyncEncryptImageNotSupport | 指定的镜像不支持转为加密自定义镜像。 |
