说明:当前页面接口为旧版 API,未来可能停止维护,目前不展示在左侧导航。云服务器 API 3.0 版本接口定义更加规范,访问时延下降显著,建议使用 云服务器 API 3.0。
1. 接口描述
本接口(ModifyImageSharePermission)用于修改镜像分享信息。
接口请求域名:image.api.qcloud.com
- 分享镜像后,被分享账户可以通过该镜像创建实例。
- 每个自定义镜像最多可共享给50个账户。
- 分享镜像无法更改名称,描述,仅可用于创建实例。
- 只支持分享到对方账户相同地域。
2. 输入参数
以下请求参数列表仅列出了接口请求参数,其它参数可参考 公共请求参数。
参数名称 | 类型 | 是否必选 | 描述 |
---|---|---|---|
Version | String | 是 | 表示API版本号,主要用于标识请求的不同 API 版本。 本接口第一版本可传:2017-03-12。 |
ImageId | String | 是 | 镜像 ID,形如img-gvbnzy6f 。镜像 ID 可以通过如下方式获取:ImageId 获取。NORMAL 的镜像。 |
AccountIds | array of Strings | 是 | 接收分享镜像的账号 ID 列表,array 型参数的格式可以参考 API 简介。账号 ID 不同于 QQ 号,查询用户账号 ID 请查看 账号信息 中的账号 ID 栏。 |
Permission | String | 是 | 操作,包括 SHARE ,CANCEL 。其中SHARE 代表分享操作,CANCEL 代表取消分享操作。 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
RequestId | String | 唯一请求 ID。每次请求都会返回一个唯一的 RequestId,当客户调用接口失败需要后台研发人员处理时需提供该 RequestId。 |
4. 错误码
以下错误码表仅列出了该接口的业务逻辑错误码,更多错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InvalidAccountId.NotFound | 无效的账号 ID。 |
InvalidAccountIs.YourSelf | 账号 ID 不能指定自己的账号 ID。 |
OverQuota | 镜像分享次数超过限制。 |
5. 示例
输入
https://image.api.qcloud.com/v2/index.php?Action=ModifyImageSharePermission &Version=2017-03-12 &ImageId=img-6pb6lrmy &AccountIds.1=1038493875 &Permission=SHARE &<公共请求参数>
输出
{ "Response": { "RequestID": "354f4ac3-8546-4516-8c8a-69e3ab73aa8a" } }