复制镜像

最近更新时间:2019-12-02 17:32:59

说明:

当前页面接口为旧版 API,未来可能停止维护,目前不展示在左侧导航。云服务器 API 3.0 版本接口定义更加规范,访问时延下降显著,建议使用 云服务器 API 3.0

1. 接口描述

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

接口请求域名:image.api.qcloud.com

  • 镜像服务目前免费。
  • 用户可以把自定义镜像同步到不同地区。
  • 每个地域最多只支持创建10个自定义镜像。
  • 可以通过 DescribeImages 接口查询镜像同步情况,对于其中 status 为 4 和 5 的情况,则分别表示同步(目的地域)和复制中(源地域)的镜像。
  • 不支持北美地区。

2. 输入参数

以下请求参数列表仅列出了接口请求参数,其它参数见公共请求参数页面。

参数名称 是否必选 类型 描述
srcRegion String 源镜像所属地域,填写代号,如gz,sh。可从 DescribeProductRegionList API获取。
imgIdList.n String 镜像ID。可通过 DescribeImages 接口返回值中的 unImgId 获取(此接口支持同时传入多个ID。此参数的具体格式可参考API简介id.n一节)。
dstRegion.n String 需要同步到的地域,填写代号,如gz,sh。

3. 输出参数

参数名称 类型 描述
code Int 公共错误码。0表示成功,其他值表示失败。
message String 模块错误信息描述,与接口相关。

4. 示例

输入

  https://image.api.qcloud.com/v2/index.php?Action=SyncCvmImage
  &srcRegion=gz
  &imgIdList.0=1
  &dstRegion.0=sh
  &desRegion.1=hk
  &<公共请求参数>

输出

{
    "code": 0,
    "message": ""
}