Call the DescribeInstanceTypes operation to query information about all instance types provided by ECS, or to query information about the specified instance types.

Usage notes

You can call this operation to query only the configuration and performance information of instance types. To query instance types that can be purchased in a specific availability zone, use DescribeAvailableResource.

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.

Go to debug

Request parameters

Only the request parameters specific to this operation and some common parameters are listed below. For details, refer to Common parameters.

Action string required Sample value: DescribeInstanceTypes

The operation that you want to perform. Valid value: DescribeInstanceTypes.

Version stringrequired Sample value: 2020-04-01

The API version. Value: 2020-04-01.

ImageId string Optional Sample value: image-ydam1k535clzp*****

The ID of the image. You can specify this parameter to query the types of instances that can be created based on the image.

InstanceTypeIds.N string[] Optional Sample value: InstanceTypeIds.1=ecs.g3i.large&InstanceTypeIds.2=ecs.g1ve.8xlarge

The instance type that you want to query. For valid values, see Instance types.

Parameter - N: This specifies the serial number of the instance type. Valid value: 1–100. When N is greater than 100, only the first 100 sequence numbers take effect.

Separate multiple InstanceTypeId values with &.

tip

By default, if you do not configure this parameter, information about all instance types is queried.

MaxResults integer Optional Sample value: 10

The number of entries returned on each page in a pagination query.

Maximum value: 1000

Minimum value: 1

Default value: 10

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 Response structure.

InstanceTypes object[] Sample value: --

The information about instance types that meet the conditions.

AffinityGroupSizes integer[] Sample value: 2

The affinity group specification.

BaselineCredit long Sample value: 20

The baseline CPU performance that a burstable instance can steadily provide is determined by its instance type.

Gpu object Sample value: --

The GPU specification information.

GpuDevices object[] Sample value: --

The list of GPU device information.

Count integer Sample value: 4

The number of GPU cards.

Memory object Sample value: --

The video memory information.

EncryptedSize integer Sample value: 8192

The encrypted memory size. Unit: MiB. Valid range: 0 to 256 * 1024.

When the InstanceTypeFamily value is ecs.ebmg2t (denoting a Security Enhanced EBM instance), encrypted memory is allocated, with a maximum capacity of 256 GiB. For all other instance types, the default allocated encrypted memory is 0 GiB.

The Security Enhanced EBM instance is in Beta. If you need a trial, contact your account manager.

Size integer Sample value: 4096

Memory size. Unit: MiB.

ProductName string Sample value: NVIDIA A100

The GPU model.

InitialCredit long Sample value: 60

The CPU credits you can obtain at one time after you create a burstable instance. You can obtain 30 credits per vCPU.

InstanceTypeFamily string Sample value: ecs.g3i

The instance family.

InstanceTypeId string Sample value: ecs.g3i.large

Instance type.

IsSupportAffinityGroup boolean Sample value: false

Whether the instance type supports affinity groups. Valid values:

true: Supported.

false: Not supported.

IsSupportJumboFrame boolean Sample value: false

Whether the instance type supports jumbo frames. Valid values:

true: Supported.

false: Not supported.

LocalVolumes object[] Sample value: --

The local volume configuration information corresponding to the instance type.

Count integer Sample value: 4

The number of local volumes mounted to the instance.

Size integer Sample value: 200

The capacity of one local volume mounted on the instance. Unit: GiB

VolumeType string Sample value: LOCAL_SSD

The local volume type. Valid values:

LOCAL_SSD: local SSD

LOCAL_HDD: local HDD

Memory object Sample value: --

The memory information of the instance type.

EncryptedSize integer Sample value: 8192

The encrypted memory size. Unit: MiB. Valid range: 0 to 256 * 1024.

When the InstanceTypeFamily value is ecs.ebmg2t (denoting a Security Enhanced EBM instance), encrypted memory is allocated, with a maximum capacity of 256 GiB. For all other instance types, the default allocated encrypted memory is 0 GiB.

The Security Enhanced EBM instance is in Beta. If you need a trial, contact your account manager.

Size integer Sample value: 4096

Memory size. Unit: MiB.

Network object Sample value: --

The network information of the instance type.

VrdmaCrossS2BandwidthMbps integer Sample value: 50

The rate limiting bandwidth of the vRdam cross-S2 switch. Unit: Mbps.

BaselineBandwidthMbps integer Sample value: 2000

The network baseline bandwidth capability (outbound/inbound). Unit: Mbps.

MaximumBandwidthMbps integer Sample value: 2000

The peak network bandwidth (outbound/inbound). Unit: Mbps.

tip

If the specified instance type does not support burst capability, the return value of MaximumBandwidthMbps is the same as the value of BaselineBandwidthMbps. For instance types with burst capability, see Instance types.

MaximumNetworkInterfaces integer Sample value: 8

The maximum number of elastic network interfaces that can be mounted.

The maximum number of elastic network interfaces that can be mounted varies based on the instance type. For more information, see Instance types.

MaximumPrivateIpv4AddressesPerNetworkInterface integer Sample value: 20

The maximum number of IPv4 addresses for a single elastic network interface. For more information, see Instance types.

MaximumQueuesPerNetworkInterface integer Sample value: 16

The maximum number of queues supported by a single elastic network interface, including those supported by the primary and secondary network interfaces. For more information, see Instance types.

MaximumThroughputKpps integer Sample value: 150

The maximum throughput (outbound + inbound), in Kpps.

Processor object Sample value: --

The CPU information of the instance type.

BaseFrequency float Sample value: 2.3

The CPU base frequency. Unit: GHz.

Cpus integer Sample value: 8

Number of CPUs.

Model string Sample value: Intel Xeon(Ice Lake) Platinum 8336C

The CPU model.

TurboFrequency float Sample value: 3.0

The CPU Turbo Boost frequency. Unit: GHz.

Rdma object Sample value: --

The RDMA specification information.

RdmaNetworkInterfaces integer Sample value: 2

The number of RDMA network interfaces.

RdmaProductName string Sample value: Mellanox BlueField3

The model of the RDMA network interface.

Volume object Sample value: --

The volume information of the instance type.

MaximumCount integer Sample value: 16

The maximum number of volumes that can be mounted.

The maximum number of volumes that can be mounted varies based on the instance type. For more information, see Instance types. Valid values:

4: Maximum number of volumes supported by t2 burstable instances.

15: Maximum number of volumes supported by first-generation instances except for g1ie, c1ie, and r1ie.

16: Maximum number of volumes supported by g1ie, c1ie, r1ie, and second- and third-generation instances.

SupportedVolumeTypes string[] Sample value: [ "ESSD_FlexPL", "ESSD_PL0"]

The list of supported volume types.

NextToken string Sample value: bHpwdXJja2RxemU1eG5sb3NzdGcW1-RCEq******

The query token returned by this API call. An empty value indicates that there is no next page.

Sample request

Sample response

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 codes	Error message	Description
400	InvalidArgument	The specified argument is invalid.	The specified parameter is invalid.
404	InvalidActionOrVersion	Could not find operation %s for version %s.	The requested API does not exist.
404	InvalidImage.NotFound	The specified image does not exist.	The specified image does not exist.
429	FlowLimitExceeded	You've reached the limit on request rate of resources.	You have exceeded the rate limit for resource requests.
500	InternalError	An internal error has occurred.	An internal error occurred. Try again. If multiple attempts fail, submit a ticket.

Elastic Compute Service