DescribeImageSharePermission - 查询一份自定义镜像已经共享的所有用户

调用DescribeImageSharePermission接口,并可以指定RegionId、ImageId等参数,查询自定义镜像已经共享的所有用户。持返回结果支分页显示,每页的信息条目默认为10条。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ecs:DescribeImageSharePermissionget
*Image
acs:ecs:{#regionId}:{#accountId}:image/{#imageId}

请求参数

名称类型必填描述示例值
RegionIdstring

自定义镜像所属的地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。

cn-hangzhou
ImageIdstring

自定义镜像 ID。

m-bp1caf3yicx5jlfl****
PageNumberinteger

查询结果显示的页码。

起始值:1。

默认值:1。

1
PageSizeinteger

查询结果显示的每页的信息条目数。

最大值:100。

默认值:10。

10

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
PageNumberinteger

查询结果显示的页码。

1
PageSizeinteger

每页的信息条目数。

10
TotalCountinteger

记录总数。

1
ImageIdstring

自定义镜像 ID。

m-bp1caf3yicx5jlfl****
RegionIdstring

镜像所属地域 ID。

cn-hangzhou
ShareGroupsarray<object>

共享组。

ShareGroupobject

共享组。

Groupstring

共享分组。

all
Accountsarray<object>

阿里云注册用户。

Accountobject

阿里云注册用户。

AliyunIdstring

阿里云账号 ID。

123456****
SharedTimestring

镜像共享开始时间。时间格式按照ISO 8601标准表示,并需要使用 UTC 时间。 格式为:yyyy-MM-ddTHH:mm:ssZ。

2023-01-01T12:05:00Z

示例

正常返回示例

JSON格式

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 1,
  "ImageId": "m-bp1caf3yicx5jlfl****",
  "RegionId": "cn-hangzhou",
  "ShareGroups": {
    "ShareGroup": [
      {
        "Group": "all"
      }
    ]
  },
  "Accounts": {
    "Account": [
      {
        "AliyunId": "123456****",
        "SharedTime": "2023-01-01T12:05:00Z"
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400MissingParameterThe input parameter "RegionId "that is mandatory for processing this request is not supplied.-
400MissingParameterThe input parameter "ImageId "that is mandatory for processing this request is not supplied.-
404InvalidImageId.NotFoundThe specified ImageId does not exist.指定的镜像在该用户账号下不存在,请您检查镜像 ID 是否正确。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-05-17OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情