DescribeImageSharePermission - Elastic Compute Service - Alibaba Cloud Documentation Center

Queries all users with whom a custom image is shared. The returned results support pagination, with 10 entries per page by default.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ecs:DescribeImageSharePermission

get

*Image

acs:ecs:{#regionId}:{#accountId}:image/{#imageId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the custom image. You can call DescribeRegions to query the most recent region list.	cn-hangzhou
ImageId	string	Yes	The ID of the custom image.	m-bp1caf3yicx5jlfl****
PageNumber	integer	No	The page number of the returned results. Minimum value: 1. Default value: 1.	1
PageSize	integer	No	The number of entries per page in the returned results. Maximum value: 100. Default value: 10.	10

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
PageNumber	integer	The page number of the returned results.	1
PageSize	integer	The number of entries per page.	10
TotalCount	integer	The total number of records.	1
ImageId	string	The ID of the custom image.	m-bp1caf3yicx5jlfl****
RegionId	string	The region ID of the image.	cn-hangzhou
ShareGroups	object
ShareGroup	array<object>	The share groups.
	object	The share groups.
Group	string	The shared group.	all
Accounts	object
Account	array<object>	The Alibaba Cloud registered users.
	object	The Alibaba Cloud registered users.
AliyunId	string	The ID of the Alibaba Cloud account.	123456****
SharedTime	string	The time when the image was shared. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2023-01-01T12:05:00Z

Examples

Success response

JSON format

{
  "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"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	MissingParameter	The input parameter "RegionId "that is mandatory for processing this request is not supplied.
404	InvalidImageId.NotFound	The specified image %s does not exist.	The specified image does not exist under the current account. check whether the image id is correct.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.