Query supported instance types for an image with DescribeImageSupportInstanceTypes - Elastic Compute Service - Alibaba Cloud - Elastic Compute Service

Queries the instance types supported by a specified image.

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:DescribeImageSupportInstanceTypes

get

*Image

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

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the image. You can call DescribeRegions to query the most recent region list.	cn-hangzhou
ImageId	string	No	The image ID.	m-o6w3gy99qf89rkga****
ActionType	string	No	The scenario in which the image is used. Valid values: CreateEcs (default): instance creation. ChangeOS: replacement of the system disk or operating system.	CreateEcs
Filter	array<object>	No	The list of filter conditions for querying resources.
	object	No	The filter condition for querying resources.
Key	string	No	The filter condition key. Currently, only filtering by image ID is supported. Valid values: imageId: filters by image ID. filter: filters by image ID. Note This parameter is not effective and will be deprecated soon.	imageId
Value	string	No	The filter condition value. Note This parameter is not effective and will be deprecated soon.	m-o6w3gy99qf89rkga****

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
ImageId	string	The ID of the queried image.	m-o6w3gy99qf89rkga****
RegionId	string	The region ID of the image.	cn-hangzhou
InstanceTypes	object
InstanceType	array<object>	The collection of instance types.
	object	The instance type information.
InstanceTypeId	string	Queries the instance types supported by an image.	ecs.t1.xsmall
InstanceTypeFamily	string	DescribeImageSupportInstanceTypes	ecs.t1
CpuCoreCount	integer	The number of vCPUs of the instance type.	1
MemorySize	number	The memory size of the instance type. Unit: GiB.	1024

Examples

Success response

JSON format

{
  "RequestId": " 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "ImageId": "m-o6w3gy99qf89rkga****",
  "RegionId": "cn-hangzhou",
  "InstanceTypes": {
    "InstanceType": [
      {
        "InstanceTypeId": "ecs.t1.xsmall",
        "InstanceTypeFamily": "ecs.t1",
        "CpuCoreCount": 1,
        "MemorySize": 1024
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParamter	Invalid Parameter.	The specified parameter is invalid.
400	InvalidInstanceType.ValueNotSupported	The specified InstanceType does not exist or beyond the permitted range.	The specified instance type does not exist or you are not authorized to manage instances of this instance type.
404	InvalidUsage	The specifed Usage is not valid.	The specified Usage parameter is invalid.
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.