修改镜像分享信息

最近更新时间:2018-08-17 17:02:50

1. 接口描述

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

本接口(ModifyImageSharePermission)用于修改镜像分享信息。

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

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ModifyImageSharePermission
Version String 公共参数,本接口取值:2017-03-12
Region String 公共参数,详见产品支持的地域列表
ImageId String 镜像ID,形如img-gvbnzy6f。镜像Id可以通过如下方式获取:
  • 通过DescribeImages接口返回的ImageId获取。
  • 通过镜像控制台获取。
    镜像ID必须指定为状态为NORMAL的镜像。镜像状态请参考镜像数据表
  • AccountIds.N Array of String 接收分享镜像的账号Id列表,array型参数的格式可以参考API简介。帐号ID不同于QQ号,查询用户帐号ID请查看帐号信息中的帐号ID栏。
    Permission String 操作,包括 SHARECANCEL。其中SHARE代表分享操作,CANCEL代表取消分享操作。

    3. 输出参数

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

    4. 错误码

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

    错误码 描述
    InvalidAccountId.NotFound 无效的账户Id。
    InvalidAccountIs.YourSelf 你无法共享镜像给自己。
    OverQuota 镜像共享超过配额。

    5. 示例

    示例1 共享镜像

    输入示例

    https://cvm.tencentcloudapi.com/?Action=ModifyImageSharePermission
    &ImageId=img-6pb6lrmy
    &AccountIds.0=1038493875
    &Permission=SHARE
    &<公共请求参数>

    输出示例

    {
      "Response": {
        "RequestId": "71e69b56-32be-4412-ab45-49eded6a87be"
      }
    }

    6. 其他资源

    云 API 3.0 提供了配套的开发工具,能更方便的调用 API 。