共享镜像

最近更新时间:2018-09-10 21:36:36

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

1. 接口描述

本接口 (ShareImage) 用于共享镜像。

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

  • 共享镜像后,镜像的共享人可以通过这个镜像创建实例。
  • 每个自定义镜像最多可共享给50个账户。
  • 共享镜像无法更改名称,描述,仅可用于创建实例。
  • 只支持共享到对方账户相同地域内。

2. 输入参数

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

参数名称 是否必选 类型 描述
imageId String 镜像ID,可通过 DescribeImages 接口返回字段中的 unImgId 获取。
uinList.n String 被共享人的账号(此接口支持同时传入多个ID。此参数的具体格式可参考API简介id.n一节)。

3. 输出参数

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

4. 示例

输入


https://image.api.qcloud.com/v2/index.php?Action=ShareImage
&imageId=img-apatyoed
&uinList.0=909619400
&<公共请求参数>

输出

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