DescribeInstanceTypes
Queries the information list of all instance types provided by Elastic Compute Service (ECS) and associates to retrieve the detailed information of instance types. You can also perform a conditional query for specific instance types to understand the configurations and performance of different instance types and select the instance types that best suit your business requirements.
Operation description
-
Paged query: Set the MaxResults parameter to limit the number of instance type entries returned. If only some of the queried instance type entries are returned, the NextToken parameter value is returned in synchronization. Invoke this operation again with the NextToken parameter value returned from the previous call and the MaxResults parameter to implement paging for instance type information.
-
If you call this operation without specifying the NextToken parameter for paginated retrieval, only the first page of data (up to 100 entries) is returned by default. To retrieve more data, specify the NextToken parameter for paginated retrieval or specify filter conditions to narrow down the returned data.
The maximum value of the MaxResults (maximum number of entries per page) parameter is 100. For users who called this operation in 2022, the maximum value of the MaxResults parameter remains 1600. On and after November 15, 2023, the maximum value of the MaxResults parameter is reduced to 100 for all users, and 1600 is no longer supported.
-
DescribeInstanceTypes only queries the configuration and performance information of instance types. To query the instance types available for purchase in a specific region, use DescribeAvailableResource.
-
To use instance types that are not publicly available or if you have special requirements for instance types, submit a ticket.
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| InstanceTypeFamily |
string |
No |
The instance family to which the instance type belongs. For more information about valid values, see DescribeInstanceTypeFamilies. For more information about instance families, see Instance families. |
ecs.g6 |
| InstanceTypes |
array |
No |
The specified instance types. Array length: 1 to 10. If this parameter is not specified, information about all instance types is queried. |
ecs.g6.large |
|
string |
No |
The instance type. |
ecs.g6.large |
|
| MinimumCpuCoreCount |
integer |
No |
The expected minimum number of vCPU cores when querying instance types. Valid values: positive integers. Note
If the number of vCPU cores of a queried instance type is less than the specified value, the information of that instance type is not returned. |
2 |
| MaximumCpuCoreCount |
integer |
No |
The expected maximum number of vCPU cores when querying instance types. Valid values: positive integers. Note
If the number of vCPU cores of a queried instance type is greater than the specified value, the information of that instance type is not returned. |
10 |
| MinimumMemorySize |
number |
No |
The expected minimum memory size when querying instance types. Unit: GiB. Note
If the memory size of a queried instance type is less than the specified value, the information of that instance type is not returned. |
20 |
| MaximumMemorySize |
number |
No |
The expected maximum memory size when querying instance types. Unit: GiB. Note
If the memory size of a queried instance type is greater than the specified value, the information of that instance type is not returned. |
60 |
| MinimumGPUAmount |
integer |
No |
The expected minimum number of GPUs when querying instance types. Valid values: positive integers. Note
If the number of GPUs of a queried instance type is less than the specified value, the information of that instance type is not returned. |
3 |
| MaximumGPUAmount |
integer |
No |
The expected maximum number of GPUs when querying instance types. Valid values: positive integers. Note
If the number of GPUs of a queried instance type is greater than the specified value, the information of that instance type is not returned. |
10 |
| GPUSpec |
string |
No |
The GPU type. Note
Fuzzy match is supported. For example, if the GPU type of an instance type is NVIDIA V100, you can enter NVIDIA to query the information of that instance type. |
NVIDIA V100 |
| InstanceCategory |
string |
No |
The categorization of the instance type. Valid values:
Valid values:
|
Big data |
| CpuArchitecture |
string |
No |
The CPU architecture. Valid values:
|
X86 |
| MinimumCpuSpeedFrequency |
number |
No |
The expected minimum clock speed when querying instance types. Note
If the clock speed of a queried instance type is less than the specified value, the information of that instance type is not returned. |
2.5 |
| MaximumCpuSpeedFrequency |
number |
No |
The expected maximum clock speed when querying instance types. Note
If the clock speed of a queried instance type is greater than the specified value, the information of that instance type is not returned. |
3.2 |
| MinimumCpuTurboFrequency |
number |
No |
The expected minimum turbo frequency when querying instance types. Note
If the turbo frequency of a queried instance type is less than the specified value, the information of that instance type is not returned. |
3.2 |
| MaximumCpuTurboFrequency |
number |
No |
The expected maximum turbo frequency when querying instance types. Note
If the turbo frequency of a queried instance type is greater than the specified value, the information of that instance type is not returned. |
4.1 |
| PhysicalProcessorModel |
string |
No |
The processor model. Note
Fuzzy match is supported. For example, if the processor model of an instance type is Intel Xeon(Ice Lake) Platinum 8369B, you can enter Intel to query the information of that instance type. |
Intel Xeon(Ice Lake) Platinum 8369B |
| InstanceFamilyLevel |
string |
No |
The level of the instance family. Valid values:
Valid values:
|
EntryLevel |
| MinimumInstancePpsRx |
integer |
No |
The expected minimum inbound packet forwarding rate over the internal network when querying instance types. Unit: pps. Note
If the inbound packet forwarding rate over the internal network of a queried instance type is less than the specified value, the information of that instance type is not returned. |
15 |
| MinimumInstancePpsTx |
integer |
No |
The expected minimum outbound packet forwarding rate over the internal network when querying instance types. Unit: pps. Note
If the outbound packet forwarding rate over the internal network of a queried instance type is less than the specified value, the information of that instance type is not returned. |
15 |
| MinimumInstanceBandwidthRx |
integer |
No |
The expected minimum inbound internal bandwidth limit when querying instance types. Unit: kbit/s. Note
If the inbound internal bandwidth limit of a queried instance type is less than the specified value, the information of that instance type is not returned. |
12288 |
| MinimumInstanceBandwidthTx |
integer |
No |
The expected minimum outbound internal bandwidth limit when querying instance types. Unit: kbit/s. Note
If the outbound internal bandwidth limit of a queried instance type is less than the specified value, the information of that instance type is not returned. |
12288 |
| MinimumPrimaryEniQueueNumber |
integer |
No |
The expected minimum default number of queues for the primary ENI when querying instance types. Note
If the default number of queues for the primary ENI of a queried instance type is less than the specified value, the information of that instance type is not returned. |
8 |
| MinimumSecondaryEniQueueNumber |
integer |
No |
The expected minimum default number of queues for a secondary ENI when querying instance types. Note
If the default number of queues for a secondary ENI of a queried instance type is less than the specified value, the information of that instance type is not returned. |
4 |
| MinimumEniQuantity |
integer |
No |
The expected minimum number of ENIs that can be attached when querying instance types. Note
If the maximum number of ENIs that can be attached to a queried instance type is less than the specified value, the information of that instance type is not returned. |
4 |
| MinimumQueuePairNumber |
integer |
No |
The expected minimum number of QueuePair (QP) queues per Elastic RDMA Interface (ERI) when querying instance types. Note
If the maximum number of QP queues per ERI of a queried instance type is less than the specified value, the information of that instance type is not returned. |
8 |
| MinimumEriQuantity |
integer |
No |
The expected minimum number of Elastic RDMA Interfaces (ERIs) when querying instance types. Note
If the number of ERIs of a queried instance type is less than the specified value, the information of that instance type is not returned. |
0 |
| MinimumEniPrivateIpAddressQuantity |
integer |
No |
The expected minimum number of IPv4 addresses per ENI when querying instance types. Note
If the maximum number of IPv4 addresses per ENI of a queried instance type is less than the specified value, the information of that instance type is not returned. |
2 |
| MinimumEniIpv6AddressQuantity |
integer |
No |
The expected minimum number of IPv6 addresses per ENI when querying instance types. Note
If the maximum number of IPv6 addresses per ENI of a queried instance type is less than the specified value, the information of that instance type is not returned. |
2 |
| MinimumLocalStorageAmount |
integer |
No |
The expected minimum number of local disks attached to the instance when querying instance types. Note
If the number of local disks attached to a queried instance type is less than the specified value, the information of that instance type is not returned. |
4 |
| MinimumLocalStorageCapacity |
integer |
No |
The capacity of a single local disk attached to the instance. Unit: GiB. |
40 |
| MinimumDiskQuantity |
integer |
No |
The expected minimum number of disks that can be attached when querying instance types. Note
If the maximum number of disks that can be attached to a queried instance type is less than the specified value, the information of that instance type is not returned. |
4 |
| LocalStorageCategory |
string |
No |
The type of local disk. For more information, see Local disks. Valid values:
Valid values:
|
local_ssd_pro |
| NvmeSupport |
string |
No |
Specifies whether disks attached to the instance type support NVMe. Valid values:
Valid values:
|
required |
| MinimumBaselineCredit |
integer |
No |
The expected minimum baseline vCPU computing performance (sum of all vCPUs) for burstable instances t5 and t6 when querying instance types. Note
If the baseline vCPU computing performance (sum of all vCPUs) for burstable instances t5 and t6 of a queried instance type is less than the specified value, the information of that instance type is not returned. |
12 |
| MinimumInitialCredit |
integer |
No |
The expected minimum initial vCPU CPU credits value for burstable instances t5 and t6 when querying instance types. Note
If the initial vCPU CPU credits value for burstable instances t5 and t6 of a queried instance type is less than the specified value, the information of that instance type is not returned. |
12 |
| InstanceTypeFamilies |
array |
No |
The instance families to query. Array length: 1 to 10. |
|
|
string |
No |
The instance family. |
["ecs.g6", "ecs.c6", … "ecs.r6"] |
|
| GpuSpecs |
array |
No |
The GPU types to query. Array length: 1 to 10. |
|
|
string |
No |
The GPU type to query. |
["NVIDIA V100", "NVIDIA T4", … "NVIDIA A10"] |
|
| InstanceCategories |
array |
No |
The instance type categories to query. Array length: 1 to 10. |
|
|
string |
No |
The instance type categorization to query. Valid values:
Valid values:
|
["General-purpose", "Compute-optimized", … "Enhanced"] |
|
| CpuArchitectures |
array |
No |
The CPU architectures to query. Array length: 1 to 2. |
|
|
string |
No |
The CPU architecture to query. Valid values:
|
["X86", "ARM"] |
|
| PhysicalProcessorModels |
array |
No |
The processor models to query. Array length: 1 to 10. |
|
|
string |
No |
The processor model to query. |
["Intel Xeon(Ice Lake) Platinum 8369B", "Intel Xeon(Skylake) Platinum 8163", … "Intel Xeon(Cascade Lake) Platinum 8269CY"] |
|
| LocalStorageCategories |
array |
No |
The local disk types to query. Array length: 1 to 2. |
|
|
string |
No |
The local disk type to query. For more information, see Local disks. Valid values:
Valid values:
|
["local_hdd_pro", "local_ssd_pro"] |
|
| MaxResults |
integer |
No |
The maximum number of entries per page in a paging query. Maximum value: 1600. Default value: 1600. |
10 |
| NextToken |
string |
No |
The query token. Set this parameter to the NextToken value returned in the previous call to this operation. You do not need to set this parameter for the first call. |
e71d8a535bd9cc11 |
| AdditionalAttributes |
array |
No |
The list of advanced features of instance types to return. |
|
|
string |
No |
The additional attribute. Valid values of N: 1 to 20. Valid values:
|
NetworkInfo.BandwidthWeighting |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The list of queried instance types. |
||
| RequestId |
string |
The request ID. |
00827261-20B7-4562-83F2-4DF39876A45A |
| InstanceTypes |
object |
||
| InstanceType |
array<object> |
The collection of instance types. |
|
|
array<object> |
The collection of instance types. |
||
| EniTotalQuantity |
integer |
The maximum number of network interface controllers (NICs) that can be attached, including primary NICs, Elastic Network Interfaces (ENIs), and trunk NICs. Note
This parameter is in invitational preview and is not publicly available. |
0 |
| LocalStorageCategory |
string |
The type of local disk. For more information, see Local disks. Valid values:
|
local_ssd_pro |
| PrimaryEniQueueNumber |
integer |
The default number of queues supported by the primary ENI. |
4 |
| MemorySize |
number |
The memory size. Unit: GiB. |
16 |
| LocalStorageCapacity |
integer |
The capacity of each local disk attached to the instance. Unit: GiB. |
5000 |
| InstanceFamilyLevel |
string |
The level of the instance family. Valid values:
|
EnterpriseLevel |
| InstancePpsRx |
integer |
The inbound packet forwarding rate over the internal network. Unit: pps. |
500000 |
| EniIpv6AddressQuantity |
integer |
The maximum number of IPv6 addresses per network interface controller (NIC). |
1 |
| MaximumQueueNumberPerEni |
integer |
The maximum number of queues per network interface controller (NIC), including primary and secondary NICs. |
4 |
| InstanceTypeId |
string |
The instance type ID. |
ecs.g6.large |
| InstanceBandwidthRx |
integer |
The maximum inbound internal bandwidth. Unit: kbit/s. |
1024000 |
| SecondaryEniQueueNumber |
integer |
The default number of queues supported by the secondary network interface controller (NIC). |
4 |
| GPUSpec |
string |
The GPU type. |
NVIDIA V100 |
| InstanceBandwidthTx |
integer |
The maximum outbound internal bandwidth. Unit: kbit/s. |
1024000 |
| QueuePairNumber |
integer |
The maximum number of QueuePair (QP) queues for all Elastic RDMA Interfaces (ERIs) on the instance. The value varies based on the instance type:
|
22 |
| EriQuantity |
integer |
The number of Elastic RDMA Interfaces (ERIs). Note
This parameter is in invitational preview and is not publicly available. |
0 |
| GPUAmount |
integer |
The number of GPUs. |
0 |
| TotalEniQueueQuantity |
integer |
The total quota of network interface controller (NIC) queues that the instance type allows you to modify. |
12 |
| NvmeSupport |
string |
Indicates whether disks attached to the instance type support NVMe. Valid values:
|
unsupported |
| DiskQuantity |
integer |
The maximum number of disks that can be attached. |
17 |
| InitialCredit |
integer |
The initial vCPU CPU credits for burstable instances t5 and t6. |
120 |
| LocalStorageAmount |
integer |
The number of local disks attached to the instance. |
1 |
| BaselineCredit |
integer |
The baseline vCPU computing performance (total of all vCPUs) for burstable instances t5 and t6. |
4 |
| InstancePpsTx |
integer |
The outbound packet forwarding rate over the internal network. Unit: pps. |
500000 |
| EniPrivateIpAddressQuantity |
integer |
The maximum number of IPv4 addresses per network interface controller (NIC). |
10 |
| CpuCoreCount |
integer |
The number of vCPU cores. |
4 |
| InstanceTypeFamily |
string |
The instance family. |
ecs.g6 |
| EniQuantity |
integer |
The maximum number of Elastic Network Interfaces (ENIs) that can be attached. |
3 |
| EniTrunkSupported |
boolean |
Indicates whether NICs attached to the instance type support trunking. Note
This parameter is in invitational preview and is not publicly available. |
true |
| CpuSpeedFrequency |
number |
The CPU clock speed. Unit: GHz. |
2.7 |
| CpuTurboFrequency |
number |
The CPU turbo frequency. Unit: GHz. |
3.5 |
| PhysicalProcessorModel |
string |
The processor model. |
Intel Xeon(Ice Lake) Platinum 8369B |
| NetworkEncryptionSupport |
boolean |
Indicates whether the instance supports VPC network traffic encryption. Valid values:
Note
This parameter is in invitational preview and is not publicly available. |
true |
| InstanceCategory |
string |
The categorization of the instance type. Valid values:
|
Big data |
| CpuArchitecture |
string |
The CPU architecture. Valid values:
|
X86 |
| GPUMemorySize |
number |
The GPU memory size per GPU. Unit: GiB. |
32 |
| NetworkCardQuantity |
integer |
The number of network cards supported by the instance type. |
1 |
| NetworkCards |
object |
||
| NetworkCardInfo |
array<object> |
The list of network card information. |
|
|
object |
The network card information. |
||
| NetworkCardIndex |
integer |
The index of the network card. |
1 |
| SupportedBootModes |
object |
||
| SupportedBootMode |
array |
The boot modes supported by the instance type. |
|
|
string |
The boot mode. Valid values:
|
BIOS |
|
| EnhancedNetwork |
object |
Note
This parameter is not publicly available. |
|
| SriovSupport |
boolean |
Note
This parameter is not publicly available. |
true |
| VfQueueNumberPerEni |
integer |
Note
This parameter is not publicly available. |
5 |
| RssSupport |
boolean |
Note
This parameter is not publicly available. |
true |
| ExpressSupport |
boolean |
||
| CpuOptions |
object |
The CPU options. |
|
| SupportedTopologyTypes |
object |
||
| SupportedTopologyType |
array |
The array of CPU topology types supported by the instance type. |
|
|
string |
The CPU topology type supported by the instance type. Valid values:
|
ContinuousCoreToHTMapping |
|
| ThreadsPerCore |
integer |
The number of threads per CPU core. Note
A value of |
2 |
| Core |
integer |
The number of CPU cores. |
2 |
| CoreFactor |
integer |
The CPU option step size. |
2 |
| HyperThreadingAdjustable |
boolean |
Indicates whether hyper-threading can be enabled or disabled. |
true |
| NestedVirtualizationSupport |
string |
Indicates whether nested virtualization is supported. |
|
| JumboFrameSupport |
boolean |
Indicates whether jumbo frames are supported. |
true |
| Clock |
object |
The clock supported by the instance type. |
|
| PtpSupport |
string |
Indicates whether Precision Time Protocol (PTP) is supported. Valid values:
|
unsupported |
| Attributes |
object |
||
| Attribute |
array<object> |
The list of instance type attributes. |
|
|
object |
The instance type attribute. |
||
| Name |
string |
The attribute name. |
VirtualIntelSpeedSelectTechnologySupport |
| Value |
string |
The attribute value. |
1 |
| NetworkInfo |
object |
The network-related information. |
|
| BandwidthWeighting |
object |
The bandwidth weighting supported by the instance type. |
|
| WeightingInfos |
object |
||
| WeightingInfo |
array<object> |
The bandwidth weighting information. This field is returned only when NetworkInfo.BandwidthWeighting is specified in the AdditionalAttributes request parameter. |
|
|
object |
|||
| Name |
string |
The bandwidth weighting name. |
Default |
| VpcBandwidth |
integer |
The baseline network bandwidth. Unit: Kbit/s. |
20480000 |
| VpcBurstBandwidth |
integer |
The burst network bandwidth. This field is not returned if the instance type does not support network performance bursting. Unit: Kbit/s. |
25600000 |
| EbsBandwidth |
integer |
The baseline storage bandwidth. Unit: Kbit/s. |
10000000 |
| EbsBurstBandwidth |
integer |
The burst storage bandwidth. This field is not returned if the instance type does not support storage performance bursting. Unit: Kbit/s. |
20000000 |
| SecurityOptions |
object |
||
| SecureBootSupport |
string |
Indicates whether the instance type supports secure boot. Valid values:
|
unsupported |
| NextToken |
string |
The query token returned by this call. |
e71d8a535bd9cc11 |
Examples
Success response
JSON format
{
"RequestId": "00827261-20B7-4562-83F2-4DF39876A45A",
"InstanceTypes": {
"InstanceType": [
{
"EniTotalQuantity": 0,
"LocalStorageCategory": "local_ssd_pro",
"PrimaryEniQueueNumber": 4,
"MemorySize": 16,
"LocalStorageCapacity": 5000,
"InstanceFamilyLevel": "EnterpriseLevel",
"InstancePpsRx": 500000,
"EniIpv6AddressQuantity": 1,
"MaximumQueueNumberPerEni": 4,
"InstanceTypeId": "ecs.g6.large",
"InstanceBandwidthRx": 1024000,
"SecondaryEniQueueNumber": 4,
"GPUSpec": "NVIDIA V100",
"InstanceBandwidthTx": 1024000,
"QueuePairNumber": 22,
"EriQuantity": 0,
"GPUAmount": 0,
"TotalEniQueueQuantity": 12,
"NvmeSupport": "unsupported",
"DiskQuantity": 17,
"InitialCredit": 120,
"LocalStorageAmount": 1,
"BaselineCredit": 4,
"InstancePpsTx": 500000,
"EniPrivateIpAddressQuantity": 10,
"CpuCoreCount": 4,
"InstanceTypeFamily": "ecs.g6",
"EniQuantity": 3,
"EniTrunkSupported": true,
"CpuSpeedFrequency": 2.7,
"CpuTurboFrequency": 3.5,
"PhysicalProcessorModel": "Intel Xeon(Ice Lake) Platinum 8369B",
"NetworkEncryptionSupport": true,
"InstanceCategory": "Big data",
"CpuArchitecture": "X86",
"GPUMemorySize": 32,
"NetworkCardQuantity": 1,
"NetworkCards": {
"NetworkCardInfo": [
{
"NetworkCardIndex": 1
}
]
},
"SupportedBootModes": {
"SupportedBootMode": [
"BIOS"
]
},
"EnhancedNetwork": {
"SriovSupport": true,
"VfQueueNumberPerEni": 5,
"RssSupport": true,
"ExpressSupport": false
},
"CpuOptions": {
"SupportedTopologyTypes": {
"SupportedTopologyType": [
"ContinuousCoreToHTMapping"
]
},
"ThreadsPerCore": 2,
"Core": 2,
"CoreFactor": 2,
"HyperThreadingAdjustable": true,
"NestedVirtualizationSupport": ""
},
"JumboFrameSupport": true,
"Clock": {
"PtpSupport": "unsupported"
},
"Attributes": {
"Attribute": [
{
"Name": "VirtualIntelSpeedSelectTechnologySupport",
"Value": "1"
}
]
},
"NetworkInfo": {
"BandwidthWeighting": {
"WeightingInfos": {
"WeightingInfo": [
{
"Name": "Default",
"VpcBandwidth": 20480000,
"VpcBurstBandwidth": 25600000,
"EbsBandwidth": 10000000,
"EbsBurstBandwidth": 20000000
}
]
}
}
},
"SecurityOptions": {
"SecureBootSupport": "unsupported"
}
}
]
},
"NextToken": "e71d8a535bd9cc11"
}
Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.