Queries the accounts with which a custom image is shared. The response can be displayed by page. By default, 10 entries are displayed per page.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | DescribeImageSharePermission | The operation that you want to perform. Set the value to DescribeImageSharePermission. |
RegionId | String | Yes | cn-hangzhou | The region ID of the custom image. You can call DescribeRegions to query the most recent region list. |
ImageId | String | Yes | m-bp1caf3yicx5jlfl**** | The ID of the custom image. |
PageNumber | Integer | No | 1 | The page number. Pages start from page 1. Default value: 1. |
PageSize | Integer | No | 10 | The number of entries per page. Valid values: 1 to 100. Default value: 10. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
RequestId | String | 473469C7-AA6F-4DC5-B3DB-A3DC0DE3**** | The ID of the request. |
PageNumber | Integer | 1 | The page number. |
PageSize | Integer | 10 | The number of entries per page. |
TotalCount | Integer | 1 | The total number of entries returned. |
ImageId | String | m-bp1caf3yicx5jlfl**** | The ID of the custom image. |
RegionId | String | cn-hangzhou | The region ID of the image. |
ShareGroups | Array of ShareGroup | The shared groups. |
|
ShareGroup | |||
Group | String | all | The shared group. |
Accounts | Array of Account | The Alibaba Cloud accounts. |
|
Account | |||
AliyunId | String | 123456**** | The ID of the Alibaba Cloud account. |
SharedTime | String | 2023-01-01T12:05:00Z | The time when the image was shared. The time follows the ISO 8601 standard in the yyyy-MM-ddThh:mmZ format. The time is displayed in UTC. |
Examples
Sample requests
http(s)://ecs.aliyuncs.com/?Action=DescribeImageSharePermission
&ImageId=m-bp1caf3yicx5jlfl****
&RegionId=cn-hangzhou
&PageNumber=1
&PageSize=10
&<Common request parameters>
Sample success responses
XML
format
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribeImageSharePermissionResponse>
<ShareGroups>
<ShareGroup>
<Group>all</Group>
</ShareGroup>
</ShareGroups>
<Accounts>
<Account>
<AliyunId>123456****</AliyunId>
</Account>
</Accounts>
<ImageId>m-bp1caf3yicx5jlfl****</ImageId>
<PageNumber>1</PageNumber>
<PageSize>10</PageSize>
<RegionId>cn-qingdao</RegionId>
<TotalCount>1</TotalCount>
<RequestId>9AD96F49-0BE5-4868-A66A-22435254****</RequestId>
</DescribeImageSharePermissionResponse>
JSON
format
HTTP/1.1 200 OK
Content-Type:application/json
{
"ShareGroups" : {
"ShareGroup" : [ {
"Group" : "all"
} ]
},
"Accounts" : {
"Account" : [ {
"AliyunId" : "123456****"
} ]
},
"ImageId" : "m-bp1caf3yicx5jlfl****",
"PageNumber" : 1,
"PageSize" : 10,
"RegionId" : "cn-qingdao",
"TotalCount" : 1,
"RequestId" : "9AD96F49-0BE5-4868-A66A-22435254****"
}
Error codes
Http status code | Error code | Error message | Description |
---|---|---|---|
404 | InvalidImageId.NotFound | The specified ImageId does not exist. | The specified image is not found in this account. Check whether the image ID is correct. |
For a list of error codes, see Service error codes.