查询镜像分享信息

最近更新时间:2023-08-09 11:42:20

说明:

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

1. 接口描述

本接口(DescribeImageSharePermission) 用于查询镜像分享信息,包括分享的账户列表。

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

2. 输入参数

以下请求参数列表仅列出了接口请求参数,其它参数可参考公共请求参数

参数名称 类型 是否必选 描述
Version String 表示API版本号,主要用于标识请求的不同API版本。 本接口第一版本可传:2017-03-12。
ImageId String 需要查询的镜像ID,形如img-gvbnzy6f。镜像ID可以通过如下方式获取:
  • 通过DescribeImages接口返回的ImageId获取。
  • 通过镜像控制台获取。
  • 3. 输出参数

    参数名称 类型 描述
    RequestId String 唯一请求ID。每次请求都会返回一个唯一的 RequestId,当客户调用接口失败需要后台研发人员处理时需提供该 RequestId。
    SharePermissionSet array of SharePermissions 描述了镜像分享信息数据结构。镜像分享信息结构如下表。

    镜像分享信息表

    参数名称 类型 描述
    CreatedTime String 镜像被分享的时间。
    Account String 镜像被分享的账号ID。账号ID不同于QQ号,查询用户账号ID请查看账号信息中的账号ID栏。

    4. 错误码

    以下错误码表仅列出了该接口的业务逻辑错误码,更多错误码详见公共错误码

    错误码 描述
    InvalidImageId.NotFound 找不到该镜像。

    5. 示例

    请求参数

    https://image.api.qcloud.com/v2/index.php?Action=DescribeImageSharePermission
    &Version=2017-03-12
    &ImageId=img-6pb6lrmy
    &<公共请求参数>
    

    返回参数

    {
        "Response": {
            "SharePermissionSet": [
                {
                    "CreatedTime":"2016-03-07T20:30:12Z",
                    "Account": "50344530"
                }
            ],
            "RequestID": "354f4ac3-8546-4516-8c8a-69e3ab73aa8a"
        }
    }