You need to enable JavaScript to run this app.
Elastic Compute Service

Elastic Compute Service

Copy page
Download PDF
Images
DescribeImageSharePermission - Queries image sharing information
Copy page
Download PDF
DescribeImageSharePermission - Queries image sharing information
Call the DescribeImageSharePermission operation to query all accounts to whom a custom image is shared.​
Debugging​
API Explorer
You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.
​
Request parameters​
Only the request parameters specific to this operation and some common parameters are listed below. For more information, refer to Common parameters.​
Action string required Sample value: DescribeImageSharePermission​
The action that you want to perform. Value: DescribeImageSharePermission.​
​
Version string required Sample value: 2020-04-01​
The version of the API. Valid value: 2020-04-01.​
​
ImageId string required Sample value: image-ebgy1og99tfct0gw****​
The image ID. You can call the DescribeImages operation and configure the Visibility=private parameter to query and obtain the ID of the custom image.​
​
MaxResults integer Optional Sample value: 15​
The number of entries per page.​
  • Default value: 15.​
  • Value range: 1 to 100.​
​
NextToken string Optional Sample value: --​
Pagination token marking the query position. Omit this parameter for initial API requests. In the next query, set the NextToken parameter to the value returned by the previous API call.​
​
​
​
Response parameters​
Only the response parameters specific to this operation are listed below. For more information, refer to the response structure.​
Accounts object[] Sample value: --​
The information of one or more accounts to which the image is shared.​
AccountId string Sample value: 210005****​
The account ID.​
​
​
ImageId string Sample value: image-4431h3l7hl31a0******​
The image ID.​
​
NextToken string Sample value: bHpwdXJja2RxemU1eG5sb3NzdGcW1-RCEq******​
The pagination token returned by this call. If this value is empty, the current page is the last page.​
​
​
​
Sample request​
​
GET /?Action=DescribeImageSharePermission&Version=2020-04-01&ImageId=image-ebgy1og99tfct0gw**** HTTP/1.1​
Host: ecs.cn-beijing.volcengineapi.com​
Region: cn-beijing​
Service: ecs​
​
Sample response​
​
{​
"ResponseMetadata": {​
"RequestId": "202106111445100102252431000052****",​
"Action": "DescribeImageSharePermission",​
"Version": "2020-04-01",​
"Service": "ecs",​
"Region": "cn-beijing"​
},​
"Result": {​
"NextToken":"bHpwdXJja2RxemU1eG5sb3NzdGcW1-RCEq******",​
"ImageId": "image-ebgy1og99tfct0gw****",​
"Accounts": [​
{​
"AccountId": "210005****"​
}​
]​
}​
}​
​
Error codes​
The table below lists the business-related error codes of the operation. For more information, refer to Common error codes.​
​
Status code​
Error code​
Error message​
Description​
400​
InvalidArgument​
The specified argument is invalid.​
The specified parameter is invalid.​
400​
MissingParameter.ImageId​
The required parameter ImageId is not supplied.​
The image ID cannot be empty.​
404​
InvalidImage.NotFound​
The specified image does not exist.​
The specified image does not exist.​
500​
InternalError​
An internal error has occurred.​
An internal error occurred. Try again. If multiple attempts fail, submit a ticket.​
​
​
Last updated: 2026.06.18 17:48:24