Queries the information about all instance types provided by Elastic Compute Service (ECS) and obtains the detailed information about the instance types. You can also query the information about specific instance types based on specific conditions. This helps you understand the configurations and performance of different instance types so that you can select instance types that meet your business requirements.
Operation description
-
Paginated query: You can set the MaxResults parameter to limit the number of instance types returned in each response. If only a subset of the queried instance types is returned, the NextToken parameter value is also returned. To perform a paginated query, set the NextToken parameter to the value returned by the previous call and set the MaxResults parameter.
-
If you call this API operation without passing the NextToken parameter for paginated retrieval, only the first page of data (up to 100 entries) is returned by default. To retrieve more data, pass the NextToken parameter for paginated retrieval or pass filter conditions to limit the returned data range.
The maximum value of the MaxResults parameter (maximum entries per page) is 100. For users who called this API before 2022, the maximum value of MaxResults remains 1600. On and after November 15, 2023, the maximum value of MaxResults will be reduced to 100 for all users, and 1600 will no longer be supported.
-
DescribeInstanceTypes only queries the configuration and performance information of instance types. To query instance types available for purchase in a specific region, use DescribeAvailableResource.
-
If you require instance types that are not publicly available for sale or have special requirements, submit a ticket.
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| InstanceTypeFamily |
string |
No |
The instance family that the instance type belongs to. For 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 by default. |
ecs.g6.large |
|
string |
No |
The instance type. |
ecs.g6.large |
|
| MinimumCpuCoreCount |
integer |
No |
The minimum number of vCPU cores when you query instance types. Valid values: positive integers. Note
Instance types with fewer vCPU cores than the specified value are not returned. |
2 |
| MaximumCpuCoreCount |
integer |
No |
The maximum number of vCPU cores when you query instance types. Valid values: positive integers. Note
Instance types with more vCPU cores than the specified value are not returned. |
10 |
| MinimumMemorySize |
number |
No |
The minimum memory size when you query instance types. Unit: GiB. Note
Instance types with a memory size smaller than the specified value are not returned. |
20 |
| MaximumMemorySize |
number |
No |
The maximum memory size when you query instance types. Unit: GiB. Note
Instance types with a memory size larger than the specified value are not returned. |
60 |
| MinimumGPUAmount |
integer |
No |
The minimum number of GPUs when you query instance types. Valid values: positive integers. Note
Instance types with fewer GPUs than the specified value are not returned. |
3 |
| MaximumGPUAmount |
integer |
No |
The maximum number of GPUs when you query instance types. Valid values: positive integers. Note
Instance types with more GPUs than the specified value are not returned. |
10 |
| GPUSpec |
string |
No |
The GPU type. Note
Fuzzy matching is supported. For example, if the GPU type of an instance type is NVIDIA V100, you can enter NVIDIA to query the instance type. |
NVIDIA V100 |
| InstanceCategory |
string |
No |
The category of the instance type. Valid values:
|
Big data |
| CpuArchitecture |
string |
No |
The CPU architecture. Valid values:
|
X86 |
| MinimumCpuSpeedFrequency |
number |
No |
The minimum CPU base clock speed when you query instance types. Note
Instance types with a base clock speed lower than the specified value are not returned. |
2.5 |
| MaximumCpuSpeedFrequency |
number |
No |
The maximum CPU base clock speed when you query instance types. Note
Instance types with a base clock speed higher than the specified value are not returned. |
3.2 |
| MinimumCpuTurboFrequency |
number |
No |
The minimum CPU turbo frequency when you query instance types. Note
Instance types with a turbo frequency lower than the specified value are not returned. |
3.2 |
| MaximumCpuTurboFrequency |
number |
No |
The maximum CPU turbo frequency when you query instance types. Note
Instance types with a turbo frequency higher than the specified value are not returned. |
4.1 |
| PhysicalProcessorModel |
string |
No |
The processor model. Note
Fuzzy matching 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 instance type. |
Intel Xeon(Ice Lake) Platinum 8369B |
| InstanceFamilyLevel |
string |
No |
The level of the instance family. Valid values:
|
EntryLevel |
| MinimumInstancePpsRx |
integer |
No |
The minimum inbound packet forwarding rate over the internal network when you query instance types. Unit: pps. Note
Instance types with an inbound packet forwarding rate lower than the specified value are not returned. |
15 |
| MinimumInstancePpsTx |
integer |
No |
The minimum outbound packet forwarding rate over the internal network when you query instance types. Unit: pps. Note
Instance types with an outbound packet forwarding rate lower than the specified value are not returned. |
15 |
| MinimumInstanceBandwidthRx |
integer |
No |
The minimum inbound internal bandwidth when you query instance types. Unit: kbit/s. Note
Instance types with an inbound internal bandwidth lower than the specified value are not returned. |
12288 |
| MinimumInstanceBandwidthTx |
integer |
No |
The minimum outbound internal bandwidth when you query instance types. Unit: kbit/s. Note
Instance types with an outbound internal bandwidth lower than the specified value are not returned. |
12288 |
| MinimumPrimaryEniQueueNumber |
integer |
No |
The minimum default number of queues supported by the primary ENI when you query instance types. Note
Instance types with fewer default queues on the primary ENI than the specified value are not returned. |
8 |
| MinimumSecondaryEniQueueNumber |
integer |
No |
The minimum default number of queues supported by the secondary ENI when you query instance types. Note
Instance types with fewer default queues on the secondary ENI than the specified value are not returned. |
4 |
| MinimumEniQuantity |
integer |
No |
The minimum number of ENIs that can be attached when you query instance types. Note
Instance types that support fewer ENIs than the specified value are not returned. |
4 |
| MinimumQueuePairNumber |
integer |
No |
The minimum number of QueuePair (QP) queues per Elastic RDMA Interface (ERI) when you query instance types. Note
Instance types with fewer QP queues per ERI than the specified value are not returned. |
8 |
| MinimumEriQuantity |
integer |
No |
The minimum number of ERIs when you query instance types. Note
Instance types with fewer ERIs than the specified value are not returned. |
0 |
| MinimumEniPrivateIpAddressQuantity |
integer |
No |
The minimum number of IPv4 addresses per ENI when you query instance types. Note
Instance types that support fewer IPv4 addresses per ENI than the specified value are not returned. |
2 |
| MinimumEniIpv6AddressQuantity |
integer |
No |
The minimum number of IPv6 addresses per ENI when you query instance types. Note
Instance types that support fewer IPv6 addresses per ENI than the specified value are not returned. |
2 |
| MinimumLocalStorageAmount |
integer |
No |
The minimum number of local disks attached to the instance when you query instance types. Note
Instance types with fewer local disks than the specified value are not returned. |
4 |
| MinimumLocalStorageCapacity |
integer |
No |
The capacity of a single local disk attached to the instance. Unit: GiB. |
40 |
| MinimumDiskQuantity |
integer |
No |
The minimum number of cloud disks that can be attached when you query instance types. Note
Instance types that support fewer cloud disks than the specified value are not returned. |
4 |
| LocalStorageCategory |
string |
No |
The category of local disks. For more information, see Local disks. Valid values:
|
local_ssd_pro |
| NvmeSupport |
string |
No |
Indicates whether cloud disks attached to the instance type support NVMe. Valid values:
|
required |
| MinimumBaselineCredit |
integer |
No |
The minimum baseline vCPU computing performance (total of all vCPUs) for burstable instance types t5 and t6 when you query instance types. Note
Instance types with a baseline vCPU computing performance lower than the specified value are not returned. |
12 |
| MinimumInitialCredit |
integer |
No |
The minimum initial vCPU credits for burstable instance types t5 and t6 when you query instance types. Note
Instance types with initial vCPU credits lower than the specified value are 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 category of the instance type to query. 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 categories to query. Array length: 1 to 2. |
|
|
string |
No |
The category of local disks to query. For more information, see Local disks. Valid values:
|
["local_hdd_pro", "local_ssd_pro"] |
|
| MaxResults |
integer |
No |
The maximum number of entries per page for a paginated query. Maximum value: 1600. Default value: 1600. |
10 |
| NextToken |
string |
No |
The pagination token. Set this parameter to the NextToken value returned in the previous call to this API operation. You do not need to set this parameter for the first request. |
e71d8a535bd9cc11 |
| AdditionalAttributes |
array |
No |
The list of advanced features to return for instance types. |
|
|
string |
No |
The additional attribute. Valid values of N: 1 to 20. Valid values:
|
NetworkInfo.BandwidthWeighting |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The queried instance type information. |
||
| RequestId |
string |
The request ID. |
00827261-20B7-4562-83F2-4DF39876A45A |
| InstanceTypes |
object |
||
| InstanceType |
array<object> |
The instance types. |
|
|
array<object> |
The instance types. |
||
| EniTotalQuantity |
integer |
The maximum number of network interfaces that can be attached to an instance. This total includes the primary network interface, elastic network interfaces (ENIs), and trunk network interfaces. Note
This parameter is in invitation-only preview and is not yet available. |
0 |
| LocalStorageCategory |
string |
The local disk category. For more information, see Local disks. Valid values:
|
local_ssd_pro |
| PrimaryEniQueueNumber |
integer |
The default number of queues for the primary network interface. |
4 |
| MemorySize |
number |
The memory size. Unit: GiB. |
16 |
| LocalStorageCapacity |
integer |
The capacity of a single local disk. Unit: GiB. |
5000 |
| InstanceFamilyLevel |
string |
The instance type family level. Valid values:
|
EnterpriseLevel |
| InstancePpsRx |
integer |
The maximum inbound internal network rate. Unit: packets per second (pps). |
500000 |
| EniIpv6AddressQuantity |
integer |
The maximum number of IPv6 addresses that can be assigned to an elastic network interface. |
1 |
| MaximumQueueNumberPerEni |
integer |
The maximum number of queues per network interface. This applies to the primary network interface and secondary elastic network interfaces. |
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 for a secondary elastic network interface. |
4 |
| GPUSpec |
string |
The GPU type. |
NVIDIA V100 |
| InstanceBandwidthTx |
integer |
The maximum outbound internal bandwidth. Unit: kbit/s. |
1024000 |
| QueuePairNumber |
integer |
The base number of Queue Pairs (QPs) for calculating the total QP capacity of an instance. The calculation method varies based on the instance type:
|
22 |
| EriQuantity |
integer |
The number of Elastic RDMA Interfaces (ERIs). Note
This parameter is in invitation-only preview and is not yet available. |
0 |
| GPUAmount |
integer |
The number of GPUs. |
0 |
| TotalEniQueueQuantity |
integer |
The total number of queues for elastic network interfaces that can be modified for the instance type. |
12 |
| NvmeSupport |
string |
Indicates whether cloud disks attached to an instance of this type support NVMe. Valid values:
|
unsupported |
| DiskQuantity |
integer |
The maximum number of cloud disks that can be attached to an instance. |
17 |
| InitialCredit |
integer |
The initial vCPU credits for a t5 or t6 burstable performance instance. |
120 |
| LocalStorageAmount |
integer |
The number of local disks attached to an instance. |
1 |
| BaselineCredit |
integer |
The baseline vCPU performance for a t5 or t6 burstable performance instance. |
4 |
| InstancePpsTx |
integer |
The maximum outbound internal network rate. Unit: packets per second (pps). |
500000 |
| EniPrivateIpAddressQuantity |
integer |
The maximum number of private IPv4 addresses that can be assigned to an elastic network interface. |
10 |
| CpuCoreCount |
integer |
The number of vCPUs. This is calculated as the number of CPU cores multiplied by the number of threads per core. |
4 |
| InstanceTypeFamily |
string |
The instance type family. |
ecs.g6 |
| EniQuantity |
integer |
The maximum number of secondary elastic network interfaces that can be attached to an instance. |
3 |
| EniTrunkSupported |
boolean |
Indicates whether network interfaces attached to an instance of this type support trunking. Note
This parameter is in invitation-only preview and is not yet available. |
true |
| CpuSpeedFrequency |
number |
The CPU base frequency. 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 an instance of this type supports VPC network traffic encryption. Valid values:
Note
This parameter is in invitation-only preview and is not yet available. |
true |
| InstanceCategory |
string |
The instance type category. Valid values:
|
Big data |
| CpuArchitecture |
string |
The CPU architecture. Valid values:
|
X86 |
| GPUMemorySize |
number |
The memory size of each GPU. Unit: GiB. |
32 |
| NetworkCardQuantity |
integer |
The number of physical network cards on an instance of this type. |
1 |
| NetworkCards |
object |
The information about the physical network cards. |
|
| NetworkCardInfo |
array<object> |
An array of physical network card details. |
|
|
object |
The details of a physical network card. |
||
| NetworkCardIndex |
integer |
The index of the physical network card. |
1 |
| SupportedBootModes |
object |
The boot modes supported by the instance type. |
|
| SupportedBootMode |
array |
An array of supported boot modes. |
|
|
string |
The boot mode. Valid values:
|
BIOS |
|
| EnhancedNetwork |
object |
Note
This parameter is not yet available. |
|
| SriovSupport |
boolean |
Note
This parameter is not yet available. |
true |
| VfQueueNumberPerEni |
integer |
Note
This parameter is not yet available. |
5 |
| RssSupport |
boolean |
Note
This parameter is not yet available. |
true |
| CpuOptions |
object |
The CPU options. |
|
| SupportedTopologyTypes |
object |
The supported CPU topology types. |
|
| SupportedTopologyType |
array |
An 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
|
2 |
| Core |
integer |
The number of CPU cores. |
2 |
| CoreFactor |
integer |
The step size for CPU options. |
2 |
| HyperThreadingAdjustable |
boolean |
Indicates whether Hyper-Threading can be enabled or disabled. |
true |
| NestedVirtualizationSupport |
string |
||
| JumboFrameSupport |
boolean |
Indicates whether an instance of this type supports jumbo frames. |
true |
| Clock |
object |
The clock sources supported by the instance type. |
|
| PtpSupport |
string |
Indicates whether an instance of this type supports Precision Time Protocol (PTP). Valid values:
|
unsupported |
| Attributes |
object |
The attributes of the instance type. |
|
| Attribute |
array<object> |
An array of instance type attributes. |
|
|
object |
An instance type attribute. |
||
| Name |
string |
The attribute name. |
VirtualIntelSpeedSelectTechnologySupport |
| Value |
string |
The attribute value. |
1 |
| NetworkInfo |
object |
The network information. |
|
| BandwidthWeighting |
object |
The bandwidth weighting supported by the instance type. |
|
| WeightingInfos |
object |
A collection of bandwidth weighting information. |
|
| WeightingInfo |
array<object> |
The bandwidth weighting information. This parameter is returned only when |
|
|
object |
The details of a bandwidth weighting configuration. |
||
| Name |
string |
The name of the bandwidth weighting. |
Default |
| VpcBandwidth |
integer |
The base network bandwidth. Unit: kbit/s. |
20480000 |
| VpcBurstBandwidth |
integer |
The burst network bandwidth. This parameter is not returned if the instance type does not support burstable network performance. Unit: kbit/s. |
25600000 |
| EbsBandwidth |
integer |
The base storage bandwidth. Unit: kbit/s. |
10000000 |
| EbsBurstBandwidth |
integer |
The burst storage bandwidth. This parameter is not returned if the instance type does not support burstable storage performance. Unit: kbit/s. |
20000000 |
| NextToken |
string |
The pagination 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
},
"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
}
]
}
}
}
}
]
},
"NextToken": "e71d8a535bd9cc11"
}
Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.