操作指南

最佳实践

故障处理

API 文档

同步镜像

最近更新时间:2021-04-27 08:04:19

我的收藏

1. 接口描述

接口请求域名: cvm.tencentcloudapi.com 。

本接口(SyncImages)用于将自定义镜像同步到其它地区。

  • 该接口每次调用只支持同步一个镜像。
  • 该接口支持多个同步地域。
  • 单个帐号在每个地域最多支持存在10个自定义镜像。

默认接口请求频率限制:10次/秒。

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:cvm.ap-shanghai-fsi.tencentcloudapi.com。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:SyncImages。
Version String 公共参数,本接口取值:2017-03-12。
Region String 公共参数,详见产品支持的 地域列表
ImageIds.N Array of String 镜像ID列表 ,镜像ID可以通过如下方式获取:
  • 通过DescribeImages接口返回的ImageId获取。
  • 通过镜像控制台获取。
    镜像ID必须满足限制:
  • 镜像ID对应的镜像状态必须为NORMAL
  • 镜像大小小于50GB。
    镜像状态请参考镜像数据表
  • DestinationRegions.N Array of String 目的同步地域列表;必须满足限制:
  • 不能为源地域,
  • 必须是一个合法的Region。
  • 暂不支持部分地域同步。
    具体地域参数请参考Region
  • 3. 输出参数

    参数名称 类型 描述
    RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 同步镜像

    同步镜像img-o3ycss2p到广州

    输入示例

    GET https://cvm.tencentcloudapi.com/?Action=SyncImages
    &ImageIds.0=img-o3ycss2p
    &DestinationRegions.0=ap-guangzhou
    &<公共请求参数>

    输出示例

    {
      "Response": {
        "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。

    命令行工具

    6. 错误码

    以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

    错误码 描述
    ImageQuotaLimitExceeded 镜像配额超过了限制。
    InvalidImageId.IncorrectState 镜像状态不合法。
    InvalidImageId.Malformed 错误的镜像Id格式。
    InvalidImageId.NotFound 未找到该镜像。
    InvalidImageId.TooLarge 镜像大小超过限制。
    InvalidImageName.Duplicate 镜像名称与原有镜像重复。
    InvalidParameter.InstanceImageNotSupport 当前接口不支持实例镜像。
    InvalidParameterValue.InvalidImageId 镜像不允许执行该操作
    InvalidParameterValue.InvalidImageState 镜像状态不合规范
    InvalidParameterValue.LimitExceeded 参数值数量超过限制。
    InvalidRegion.NotFound 未找到该区域。
    InvalidRegion.Unavailable 该区域目前不支持同步镜像。
    UnsupportedOperation.Region 不支持该地域
    目录