Queries the details of all instance types or a specific instance type provided by Elastic Compute Service (ECS).
Usage notes
Take note of the following items:
The MaxResults parameter specifies the maximum number of entries to return on each page. The maximum value of this parameter is changed from 1600 to 100. If you called this operation in 2022, you can continue to use 1600 as the maximum value of MaxResults until November 15, 2023. As of November 15, 2023, only 100 can be used as the maximum value of MaxResults. If you do not configure the NextToken parameter when you call the DescribeInstanceTypes operation, only the first page of results that contains up to 100 entries is returned. If you want to retrieve more results, configure the NextToken parameter to perform paged queries, or specify filter conditions to filter results.
We recommend that you specify MaxResults and NextToken to perform paged queries. The first time you call the DescribeInstanceTypes operation, specify MaxResults to limit the maximum number of entries to return in the call. If the number of entries to return exceeds the specified value of MaxResults, the response includes a NextToken value. You can set NextToken to this return value and specify MaxResults in your next request to DescribeInstanceTypes to retrieve the next page of results.
The DescribeInstanceTypes operation is used to query only the specifications and performance information of instance types. To query instance types that are available in a specified region, call the DescribeAvailableResource operation.
To use special instance types such as instance types that are unavailable for purchase, submit a ticket.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
Action | String | Yes | DescribeInstanceTypes | The operation that you want to perform. Set the value to DescribeInstanceTypes. |
InstanceTypeFamily | String | No | ecs.g6 | The instance family to which the instance type belongs. For information about the valid values of this parameter, see DescribeInstanceTypeFamilies. For more information about instance families, see Instance families. |
InstanceTypes.N | String | No | ecs.g6.large | Instance type N. Valid values of N: 1 to 10. If this parameter is left empty, information about all instance types is queried. |
MinimumCpuCoreCount | Integer | No | 2 | The minimum number of vCPUs. The value must be a positive integer. Note If the number of vCPUs of an instance type is smaller than the specified value, information about the instance type is not queried. |
MaximumCpuCoreCount | Integer | No | 10 | The maximum number of vCPUs. The value must be a positive integer. Note If the number of vCPUs of an instance type is greater than the specified value, information about the instance type is not queried. |
MinimumMemorySize | Float | No | 20 | The minimum memory size. Unit: GiB. Note If the memory size of an instance type is smaller than the specified value, information about the instance type is not queried. |
MaximumMemorySize | Float | No | 60 | The maximum memory size. Unit: GiB. Note If the memory size of an instance type is larger than the specified value, information about the instance type is not queried. |
MinimumGPUAmount | Integer | No | 3 | The minimum number of GPUs. The value must be a positive integer. Note If an instance type provides fewer GPUs than the specified value, information about the instance type is not queried. |
MaximumGPUAmount | Integer | No | 10 | The maximum number of GPUs. The value must be a positive integer. Note If an instance type provides more GPUs than the specified value, information about the instance type is not queried. |
GPUSpec | String | No | NVIDIA V100 | The GPU model. Note Fuzzy match is supported. For example, if an instance type provides NVIDIA V100 GPUs and you set this parameter to NVIDIA, information about the instance type is queried. |
InstanceCategory | String | No | Big data | The category of the instance type. Valid values:
|
CpuArchitecture | String | No | X86 | The CPU architecture. Valid values:
|
MinimumCpuSpeedFrequency | Float | No | 2.5 | The minimum clock speed. Note If an instance type uses processors that have a lower clock speed than the specified value, information about the instance type is not queried. |
MaximumCpuSpeedFrequency | Float | No | 3.2 | The maximum clock speed. Note If an instance type uses processors that have a higher clock speed than the specified value, information about the instance type is not queried. |
MinimumCpuTurboFrequency | Float | No | 3.2 | The minimum turbo frequency. Note If an instance type uses processors that deliver a lower turbo frequency than the specified value, information about the instance type is not queried. |
MaximumCpuTurboFrequency | Float | No | 4.1 | The maximum turbo frequency. Note If an instance type uses processors that deliver a higher turbo frequency than the specified value, information about the instance type is not queried. |
PhysicalProcessorModel | String | No | Intel Xeon(Ice Lake) Platinum 8369B | The CPU model. Note Fuzzy match is supported. For example, if an instance type uses Intel Xeon (Ice Lake) Platinum 8369B processors and you set this parameter to Intel, information about the instance type is queried. |
InstanceFamilyLevel | String | No | EntryLevel | The level of the instance family. Valid values:
|
MinimumInstancePpsRx | Long | No | 15 | The minimum inbound packet forwarding rate over the internal network. Unit: pps. Note If an instance type provides an inbound packet forwarding rate over the internal network that is lower than the specified value, information about the instance type is not queried. |
MinimumInstancePpsTx | Long | No | 15 | The minimum outbound packet forwarding rate over the internal network. Unit: pps. Note If an instance type provides an outbound packet forwarding rate over the internal network that is lower than the specified value, information about the instance type is not queried. |
MinimumInstanceBandwidthRx | Integer | No | 12288 | The minimum inbound internal bandwidth. Unit: Kbit/s. Note If an instance type provides an inbound internal bandwidth that is lower than the specified value, information about the instance type is not queried. |
MinimumInstanceBandwidthTx | Integer | No | 12288 | The minimum outbound internal bandwidth. Unit: Kbit/s. Note If an instance type provides an outbound internal bandwidth that is lower than the specified value, information about the instance type is not queried. |
MinimumPrimaryEniQueueNumber | Integer | No | 8 | The minimum default number of queues per primary elastic network interface (ENI). Note If an instance type supports fewer queues per primary ENI than the specified value, information about the instance type is not queried. |
MinimumSecondaryEniQueueNumber | Integer | No | 4 | The minimum default number of queues per secondary ENI. Note If an instance type supports fewer queues per secondary ENI than the specified value, information about the instance type is not queried. |
MinimumEniQuantity | Integer | No | 4 | The minimum number of ENIs per instance. Note If an instance type supports fewer ENIs than the specified value, information about the instance type is not queried. |
MinimumQueuePairNumber | Integer | No | 8 | The minimum number of queue pairs (QPs) per elastic RDMA interface (ERI). Note If an instance type supports fewer QPs per ERI than the specified value, information about the instance type is not queried. |
MinimumEriQuantity | Integer | No | 0 | The minimum number of ERIs per instance. Note If an instance type supports fewer ERIs than the specified value, information about the instance type is not queried. |
MinimumEniPrivateIpAddressQuantity | Integer | No | 2 | The minimum number of IPv4 addresses per ENI. Note If an instance type supports fewer IPv4 addresses per ENI than the specified value, information about the instance type is not queried. |
MinimumEniIpv6AddressQuantity | Integer | No | 2 | The minimum number of IPv6 addresses per ENI. Note If an instance type supports fewer IPv6 addresses per ENI than the specified value, information about the instance type is not queried. |
MinimumLocalStorageAmount | Integer | No | 4 | The minimum number of local disks per instance. Note If an instance type supports fewer local disks than the specified value, information about the instance type is not queried. |
MinimumLocalStorageCapacity | Long | No | 40 | The capacity of each local disk attached per instance. Unit: GiB. |
MinimumDiskQuantity | Integer | No | 4 | The minimum number of cloud disks per instance. Note If an instance type supports fewer cloud disks than the specified value, information about the instance type is not queried. |
LocalStorageCategory | String | No | local_ssd_pro | The category of local disks. For more information, see Local disks. Valid values:
|
NvmeSupport | String | No | required | Specifies whether cloud disks can be attached by using the NVMe protocol. Valid values:
|
MinimumBaselineCredit | Integer | No | 12 | The minimum baseline vCPU computing performance (overall baseline performance of all vCPUs) of a t5 or t6 burstable instance. Note If a t5 or t6 instance type provides baseline vCPU computing performance lower than the specified value, information about the instance type is not queried. |
MinimumInitialCredit | Integer | No | 12 | The minimum initial vCPU credits of a t5 or t6 burstable instance. Note If a t5 or t6 instance type provides less initial vCPU credits than the specified value, information about the instance type is not queried. |
MaxResults | Long | No | 10 | The number of entries per page. Maximum value: 1600. Default value: 1600. |
NextToken | String | No | e71d8a535bd9cc11 | The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of NextToken. |
Response parameters
Parameter | Type | Example | Description |
RequestId | String | 00827261-20B7-4562-83F2-4DF39876A45A | The request ID. |
InstanceTypes | Array of InstanceType | Details about the instance types. | |
InstanceType | |||
EniTotalQuantity | Integer | 0 | The maximum number of ENIs, including primary, secondary, and trunk ENIs. Note This parameter is in invitational preview and is not publicly available. |
LocalStorageCategory | String | local_ssd_pro | The category of local disks. For more information, see Local disks. Valid values:
|
PrimaryEniQueueNumber | Integer | 4 | The default number of queues per primary ENI. |
MemorySize | Float | 16 | The memory size. Unit: GiB. |
LocalStorageCapacity | Long | 5000 | The capacity of each local disk. Unit: GiB. |
InstanceFamilyLevel | String | EnterpriseLevel | The level of the instance family. Valid values:
For more information, see Overview. |
InstancePpsRx | Long | 500000 | The inbound packet forwarding rate over the internal network. Unit: pps. |
EniIpv6AddressQuantity | Integer | 1 | The maximum number of IPv6 addresses per ENI. |
MaximumQueueNumberPerEni | Integer | 4 | The maximum number of queues per ENI. The ENI can be a primary ENI or a secondary ENI. |
InstanceTypeId | String | ecs.g6.large | The instance type ID. |
InstanceBandwidthRx | Integer | 1024000 | The maximum inbound internal bandwidth. Unit: Kbit/s. |
SecondaryEniQueueNumber | Integer | 4 | The default number of queues per secondary ENI. |
GPUSpec | String | NVIDIA V100 | The GPU model. |
InstanceBandwidthTx | Integer | 1024000 | The maximum outbound internal bandwidth. Unit: Kbit/s. |
QueuePairNumber | Integer | 22 | The maximum number of QPs per ERI. |
EriQuantity | Integer | 0 | The number of ERIs. Note This parameter is in invitational preview and is not publicly available. |
GPUAmount | Integer | 0 | The number of GPUs. |
TotalEniQueueQuantity | Integer | 12 | The maximum number of queues on ENIs that the instance type supports. |
NvmeSupport | String | unsupported | Indicates whether the cloud disk can be attached by using the NVMe protocol. Valid values:
|
DiskQuantity | Integer | 17 | The maximum number of cloud disks per instance. |
InitialCredit | Integer | 120 | The initial vCPU credits of a t5 or t6 burstable instance. |
LocalStorageAmount | Integer | 1 | The number of local disks per instance. |
BaselineCredit | Integer | 4 | The baseline vCPU computing performance (overall performance of all vCPUs) of the t5 or t6 burstable instance. |
InstancePpsTx | Long | 500000 | The outbound packet forwarding rate over the internal network. Unit: pps. |
EniPrivateIpAddressQuantity | Integer | 10 | The maximum number of IPv4 addresses per ENI. |
CpuCoreCount | Integer | 4 | The number of vCPUs. |
InstanceTypeFamily | String | ecs.g6 | The instance family. |
EniQuantity | Integer | 3 | The maximum number of ENIs. |
EniTrunkSupported | Boolean | true | Indicates whether trunk ENIs are supported. Note This parameter is in invitational preview and is not publicly available. |
CpuSpeedFrequency | Float | 2.7 | The CPU base frequency. Unit: GHz. |
CpuTurboFrequency | Float | 3.5 | The CPU turbo frequency. Unit: GHz. |
PhysicalProcessorModel | String | Intel Xeon(Ice Lake) Platinum 8369B | The CPU model. |
NetworkEncryptionSupport | Boolean | true | Indicates whether to allow network traffic transmitted over virtual private clouds (VPCs) to be encrypted. Valid values:
|
InstanceCategory | String | Big data | The category of the instance type. Valid values:
|
CpuArchitecture | String | X86 | The CPU architecture. Valid values:
|
GPUMemorySize | Float | 32 | The memory size per GPU. Unit: GiB. |
NetworkCardQuantity | Integer | 1 | The maximum number of network cards that the instance type supports. |
NetworkCards | Array of NetworkCardInfo | Details about the network cards. | |
NetworkCardInfo | |||
NetworkCardIndex | Integer | 1 | The index of the network card. |
NextToken | String | e71d8a535bd9cc11 | The query token returned in this call. |
Examples
Sample requests
https://ecs.aliyuncs.com/?Action=DescribeInstanceTypes
&InstanceTypeFamily=ecs.g6
&InstanceTypes.1=ecs.g6.large
&<Common request parameters>Sample success responses
XML format
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribeInstanceTypesResponse>
<RequestId>00827261-20B7-4562-83F2-4DF39876A45A</RequestId>
<NextToken/>
<InstanceTypes>
<InstanceType>
<InstancePpsTx>500000</InstancePpsTx>
<NvmeSupport>unsupported</NvmeSupport>
<PrimaryEniQueueNumber>4</PrimaryEniQueueNumber>
<TotalEniQueueQuantity>12</TotalEniQueueQuantity>
<EniTrunkSupported>true</EniTrunkSupported>
<InstanceTypeFamily>ecs.g6</InstanceTypeFamily>
<InstancePpsRx>500000</InstancePpsRx>
<EriQuantity>0</EriQuantity>
<InstanceBandwidthRx>1024000</InstanceBandwidthRx>
<InstanceBandwidthTx>1024000</InstanceBandwidthTx>
<SecondaryEniQueueNumber>4</SecondaryEniQueueNumber>
<LocalStorageCategory/>
<GPUSpec/>
<InstanceTypeId>ecs.g6.xlarge</InstanceTypeId>
<MemorySize>16</MemorySize>
<MaximumQueueNumberPerEni>4</MaximumQueueNumberPerEni>
<EniIpv6AddressQuantity>1</EniIpv6AddressQuantity>
<EniTotalQuantity>5</EniTotalQuantity>
<CpuCoreCount>4</CpuCoreCount>
<EniQuantity>3</EniQuantity>
<GPUAmount>0</GPUAmount>
<DiskQuantity>17</DiskQuantity>
<QueuePairNumber>22</QueuePairNumber>
<InstanceFamilyLevel>EnterpriseLevel</InstanceFamilyLevel>
<EniPrivateIpAddressQuantity>10</EniPrivateIpAddressQuantity>
<CpuSpeedFrequency>2.7</CpuSpeedFrequency>
<CpuTurboFrequency>3.5</CpuTurboFrequency>
<PhysicalProcessorModel>Intel Xeon(Ice Lake) Platinum 8369B</PhysicalProcessorModel>
<InitialCredit>120</InitialCredit>
</InstanceType>
</InstanceTypes>
</DescribeInstanceTypesResponse>JSON format
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "00827261-20B7-4562-83F2-4DF39876A45A",
"NextToken" : "",
"InstanceTypes" : {
"InstanceType" : [ {
"InstancePpsTx" : 500000,
"NvmeSupport" : "unsupported",
"PrimaryEniQueueNumber" : 4,
"TotalEniQueueQuantity" : 12,
"EniTrunkSupported" : true,
"InstanceTypeFamily" : "ecs.g6",
"InstancePpsRx" : 500000,
"EriQuantity" : 0,
"InstanceBandwidthRx" : 1024000,
"InstanceBandwidthTx" : 1024000,
"SecondaryEniQueueNumber" : 4,
"LocalStorageCategory" : "",
"GPUSpec" : "",
"InstanceTypeId" : "ecs.g6.xlarge",
"MemorySize" : 16,
"MaximumQueueNumberPerEni" : 4,
"EniIpv6AddressQuantity" : 1,
"EniTotalQuantity" : 5,
"CpuCoreCount" : 4,
"EniQuantity" : 3,
"GPUAmount" : 0,
"DiskQuantity" : 17,
"QueuePairNumber" : 22,
"InstanceFamilyLevel" : "EnterpriseLevel",
"EniPrivateIpAddressQuantity" : 10,
"CpuSpeedFrequency" : 2.7,
"CpuTurboFrequency" : 3.5,
"PhysicalProcessorModel" : "Intel Xeon(Ice Lake) Platinum 8369B",
"InitialCredit" : "120"
} ]
}
}Error codes
For a list of error codes, see Service error codes.