租户端 计算 云服务器（CVM） 镜像相关接口 SyncImages

SyncImages

最近更新时间: 2024-12-21 13:01:32

1. 接口描述

接口请求域名： cvm.api3.gsesgpucloud.com。

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

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

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

接口更新时间：2018-04-03 17:23:06。

接口只验签名不鉴权。

2. 输入参数

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

参数名称 必选 允许NULL 类型 描述
Action 是 否 String 公共参数，本接口取值：SyncImages
Version 是 否 String 公共参数，本接口取值：2017-03-12
Region 是 否 String 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
ImageIds 是 否 Array of String 镜像ID列表 ，镜像ID可以通过如下方式获取：
  • 通过DescribeImages接口返回的ImageId获取。
  • 通过DescribeImages获取。
    镜像ID必须满足限制：
  • 镜像ID对应的镜像状态必须为NORMAL。
  • 镜像大小小于50GB。
    镜像状态请参考镜像数据表。
    示例值： ["img-o3ycss2p"]
    		•
    DestinationRegions 是 否 Array of String 目的同步地域列表；必须满足限制：
  • 不能为源地域，
  • 必须是一个合法的Region。
  • 暂不支持部分地域同步。
    具体地域参数请参考Region。
    示例值： ["ap-guangzhou"]
    		•

    3. 输出参数

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

    4. 错误码

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

    错误码 描述
    InvalidImageId.IncorrectState 镜像状态不合法。
    InvalidImageId.NotFound 未找到该镜像。
    InvalidImageId.TooLarge 镜像大小超过限制。
    InvalidRegion.NotFound 未找到该区域。
    InvalidRegion.Unavailable 该区域目前不支持同步镜像。