All Products
Search
Document Center

Elastic Compute Service:DescribeInstanceTypes

Last Updated:Nov 25, 2024

Queries the details of all instance types or a specific instance type provided by Elastic Compute Service (ECS).

Operation description

Usage notes

Take note of the following items:

  • MaxResults specifies the maximum number of entries per page. The maximum value of this parameter is changed from 1600 to 100. As of November 15, 2023, only 100 can be used as the maximum value of MaxResults. If you called the DescribeInstanceTypes operation in 2022, you can use 1600 as the maximum value before November 15, 2023. If you do not specify NextToken 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, specify NextToken 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, set MaxResults to limit the maximum number of entries that can be returned in a single call. If the number of entries to return exceeds the specified MaxResults value, the response includes a NextToken value. You can set NextToken to the 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 specific region, call the DescribeAvailableResource operation.
  • To use special instance types such as instance types that are unavailable for purchase, submit a ticket.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceTypeFamilystringNo

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.

ecs.g6
InstanceTypesarrayNo

Instance type N. Valid values of N: 1 to 10. If this parameter is left empty, information about all instance types is queried.

stringNo

Instance type N. Valid values of N: 1 to 10. If this parameter is left empty, information about all instance types is queried.

ecs.g6.large
MinimumCpuCoreCountintegerNo

The minimum number of vCPUs. The value must be a positive integer.

Note If an instance type has fewer vCPUs than the specified value, information about the instance type is not queried.
2
MaximumCpuCoreCountintegerNo

The maximum number of vCPUs. The value must be a positive integer.

Note If an instance type has more vCPUs than the specified value, information about the instance type is not queried.
10
MinimumMemorySizefloatNo

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.
20
MaximumMemorySizefloatNo

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.
60
MinimumGPUAmountintegerNo

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.
3
MaximumGPUAmountintegerNo

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.
10
GPUSpecstringNo

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.
NVIDIA V100
InstanceCategorystringNo

The category of the instance type. Valid values:

  • General-purpose: general-purpose instance type
  • Compute-optimized: compute-optimized instance type
  • Memory-optimized: memory-optimized instance type
  • Big data: big data instance type
  • Local SSDs: instance type with local SSDs
  • High Clock Speed: instance type with high clock speeds
  • Enhanced: enhanced instance type
  • Shared: shared instance type
  • Compute-optimized with GPU: GPU-accelerated compute-optimized instance type
  • Visual Compute-optimized: visual compute-optimized instance type
  • Heterogeneous Service: heterogeneous service instance type
  • Compute-optimized with FPGA: FPGA-accelerated compute-optimized instance type
  • Compute-optimized with NPU: NPU-accelerated compute-optimized instance type
  • ECS Bare Metal: ECS Bare Metal Instance type
  • Super Computing Cluster: Super Computing Cluster (SCC) instance type
  • High Performance Compute: high-performance computing instance type
Big data
CpuArchitecturestringNo

The CPU architecture. Valid values:

  • X86
  • ARM
X86
MinimumCpuSpeedFrequencyfloatNo

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.
2.5
MaximumCpuSpeedFrequencyfloatNo

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.
3.2
MinimumCpuTurboFrequencyfloatNo

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.
3.2
MaximumCpuTurboFrequencyfloatNo

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.
4.1
PhysicalProcessorModelstringNo

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.
Intel Xeon(Ice Lake) Platinum 8369B
InstanceFamilyLevelstringNo

The level of the instance family. Valid values:

  • EntryLevel: entry level (shared)
  • EnterpriseLevel: enterprise level
  • CreditEntryLevel: credit-based entry level
EntryLevel
MinimumInstancePpsRxlongNo

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.
15
MinimumInstancePpsTxlongNo

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.
15
MinimumInstanceBandwidthRxintegerNo

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.
12288
MinimumInstanceBandwidthTxintegerNo

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.
12288
MinimumPrimaryEniQueueNumberintegerNo

The minimum default number of queues per primary network interface controller (NIC).

Note If an instance type supports fewer queues per primary NIC than the specified value, information about the instance type is not queried.
8
MinimumSecondaryEniQueueNumberintegerNo

The minimum default number of queues per secondary NIC.

Note If an instance type supports fewer queues per secondary NIC than the specified value, information about the instance type is not queried.
4
MinimumEniQuantityintegerNo

The minimum number of elastic network interfaces (ENIs) per instance.

Note If an instance type supports fewer ENIs than the specified value, information about the instance type is not queried.
4
MinimumQueuePairNumberintegerNo

The minimum number of queue pair (QP) queues per elastic RDMA interface (ERI).

Note If an instance type supports fewer QP queues per ERI than the specified value, information about the instance type is not queried.
8
MinimumEriQuantityintegerNo

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.
0
MinimumEniPrivateIpAddressQuantityintegerNo

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.
2
MinimumEniIpv6AddressQuantityintegerNo

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.
2
MinimumLocalStorageAmountintegerNo

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.
4
MinimumLocalStorageCapacitylongNo

The capacity of each local disk attached per instance. Unit: GiB.

40
MinimumDiskQuantityintegerNo

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.
4
LocalStorageCategorystringNo

The category of local disks. For more information, see Local disks. Valid values:

  • local_hdd_pro: local Serial Advanced Technology Attachment (SATA) HDDs, which are attached to d1ne or d1 instances.
  • local_ssd_pro: local Non-Volatile Memory Express (NVMe) SSDs, which are attached to i2, i2g, i1, ga1, or gn5 instances.

Valid values:

  • local_hdd_pro
  • local_ssd_pro
local_ssd_pro
NvmeSupportstringNo

Specifies whether cloud disks can be attached by using the NVMe protocol. Valid values:

  • required: Cloud disks can be attached by using the NVMe protocol.
  • unsupported: Cloud disks cannot be attached by using the NVMe protocol.
required
MinimumBaselineCreditintegerNo

The minimum baseline CPU performance (overall baseline performance of all vCPUs) of a t5 or t6 burstable instance.

Note If a t5 or t6 instance type provides baseline CPU performance lower than the specified value, information about the instance type is not queried.
12
MinimumInitialCreditintegerNo

The minimum initial CPU 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.
12
InstanceTypeFamiliesarrayNo

The instance families of instance types that you want to query. Valid values of N: 1 to 10.

stringNo

The name of instance family N. Valid values of N: 1 to 10.

["ecs.g6", "ecs.c6", … "ecs.r6"]
GpuSpecsarrayNo

The GPU models of instance types. Valid values of N: 1 to 10.

stringNo

GPU model N. Valid values of N: 1 to 10.

["NVIDIA V100", "NVIDIA T4", … "NVIDIA A10"]
InstanceCategoriesarrayNo

The categories of instance types. Valid values:

Note Valid values of N: 1 to 10.
  • General-purpose: general-purpose instance type
  • Compute-optimized: compute-optimized instance type
  • Memory-optimized: memory-optimized instance type
  • Big data: big data instance type
  • Local SSDs: instance type with local SSDs
  • High Clock Speed: instance type with high clock speeds
  • Enhanced: enhanced instance type
  • Shared: shared instance type
  • Compute-optimized with GPU: GPU-accelerated compute-optimized instance type
  • Visual Compute-optimized: visual compute-optimized instance type
  • Heterogeneous Service: heterogeneous service instance type
  • Compute-optimized with FPGA: FPGA-accelerated compute-optimized instance type
  • Compute-optimized with NPU: NPU-accelerated compute-optimized instance type
  • ECS Bare Metal: ECS Bare Metal Instance type
  • Super Computing Cluster: SCC instance type
  • High Performance Compute: high-performance computing instance type
stringNo

Instance type category N. Valid values:

Note Valid values of N: 1 to 10.
  • General-purpose: general-purpose instance type
  • Compute-optimized: compute-optimized instance type
  • Memory-optimized: memory-optimized instance type
  • Big data: big data instance type
  • Local SSDs: instance type with local SSDs
  • High Clock Speed: instance type with high clock speeds
  • Enhanced: enhanced instance type
  • Shared: shared instance type
  • Compute-optimized with GPU: GPU-accelerated compute-optimized instance type
  • Visual Compute-optimized: visual compute-optimized instance type
  • Heterogeneous Service: heterogeneous service instance type
  • Compute-optimized with FPGA: FPGA-accelerated compute-optimized instance type
  • Compute-optimized with NPU: NPU-accelerated compute-optimized instance type
  • ECS Bare Metal: ECS Bare Metal Instance type
  • Super Computing Cluster: SCC instance type
  • High Performance Compute: high-performance computing instance type
["General-purpose", "Compute-optimized", … "Enhanced"]
CpuArchitecturesarrayNo

The CPU architectures of instance types. Valid values:

Note Valid values of N: 1 and 2.
  • X86
  • ARM
stringNo

CPU architecture N. Valid values:

Note Valid values of N: 1 and 2.
  • X86
  • ARM
["X86", "ARM"]
PhysicalProcessorModelsarrayNo

The CPU models of instance types. Valid values of N: 1 to 10.

stringNo

CPU model N. Valid values of N: 1 to 10.

["Intel Xeon(Ice Lake) Platinum 8369B", "Intel Xeon(Skylake) Platinum 8163", … "Intel Xeon(Cascade Lake) Platinum 8269CY"]
LocalStorageCategoriesarrayNo

The categories of local disks. Valid values of N: 1 and 2. For more information, see Local disks. Valid values:

  • local_hdd_pro: local SATA HDDs, which are attached to d1ne or d1 instances
  • local_ssd_pro: local NVMe SSDs, which are attached to i2, i2g, i1, ga1, or gn5 instances
stringNo

Category N of local disks. For more information, see Local disks. Valid values:

Note Valid values of N: 1 and 2.
  • local_hdd_pro: local SATA HDDs, which are attached to d1ne or d1 instances
  • local_ssd_pro: local NVMe SSDs, which are attached to i2, i2g, i1, ga1, or gn5 instances
["local_hdd_pro", "local_ssd_pro"]
MaxResultslongNo

The maximum number of entries per page. Valid values: 1 to 1600.

Default value: 1600.

10
NextTokenstringNo

The query token. Set the value to the NextToken value returned in the previous call to the DescribeInstanceTypes operation. You do not need to specify this parameter for the first request.

e71d8a535bd9cc11

Response parameters

ParameterTypeDescriptionExample
object

The information about the queried instance types.

RequestIdstring

The ID of the request.

00827261-20B7-4562-83F2-4DF39876A45A
InstanceTypesarray<object>

Details about the instance types.

InstanceTypeobject

Details about the instance type.

EniTotalQuantityinteger

The maximum number of ENIs, including primary, secondary, and trunk ENIs.

Note This parameter is in invitational preview and is not publicly available.
0
LocalStorageCategorystring

The category of local disks. For more information, see Local disks. Valid values:

  • local_hdd_pro: local SATA HDDs, which are attached to d1ne or d1 instances
  • local_ssd_pro: local NVMe SSDs, which are attached to i2, i2g, i1, ga1, or gn5 instances
local_ssd_pro
PrimaryEniQueueNumberinteger

The default number of queues per primary ENI.

4
MemorySizefloat

The memory size. Unit: GiB

16
LocalStorageCapacitylong

The capacity of each local disk. Unit: GiB

5000
InstanceFamilyLevelstring

The level of the instance family. Valid values:

  • EntryLevel: entry level (shared).
  • EnterpriseLevel: enterprise level.
  • CreditEntryLevel: credit-based entry level. For more information, see Overview .
EnterpriseLevel
InstancePpsRxlong

The inbound packet forwarding rate over the internal network. Unit: pps.

500000
EniIpv6AddressQuantityinteger

The maximum number of IPv6 addresses per ENI.

1
MaximumQueueNumberPerEniinteger

The maximum number of queues per ENI, including primary and secondary ENIs.

4
InstanceTypeIdstring

The ID of the instance type.

ecs.g6.large
InstanceBandwidthRxinteger

The maximum inbound internal bandwidth. Unit: Kbit/s.

1024000
SecondaryEniQueueNumberinteger

The default number of queues per secondary ENI.

4
GPUSpecstring

The GPU model.

NVIDIA V100
InstanceBandwidthTxinteger

The maximum outbound internal bandwidth. Unit: Kbit/s.

1024000
QueuePairNumberinteger

The maximum number of QPs per ERI.

22
EriQuantityinteger

The number of ERIs.

Note This parameter is in invitational preview and is not publicly available.
0
GPUAmountinteger

The number of GPUs.

0
TotalEniQueueQuantityinteger

The maximum number of queues on ENIs that the instance type supports.

12
NvmeSupportstring

Indicates whether cloud disks can be attached by using the NVMe protocol. Valid values:

  • required: Cloud disks can be attached by using the NVMe protocol.
  • unsupported: Cloud disks cannot be attached by using the NVMe protocol.
unsupported
DiskQuantityinteger

The maximum number of cloud disks per instance.

17
InitialCreditinteger

The initial vCPU credits per t5 or t6 burstable instance.

120
LocalStorageAmountinteger

The number of local disks per instance.

1
BaselineCreditinteger

The baseline vCPU computing performance (overall baseline performance of all vCPUs) per t5 or t6 burstable instance.

4
InstancePpsTxlong

The outbound packet forwarding rate over the internal network. Unit: pps.

500000
EniPrivateIpAddressQuantityinteger

The maximum number of IPv4 addresses per ENI.

10
CpuCoreCountinteger

The number of vCPUs.

4
InstanceTypeFamilystring

The instance family.

ecs.g6
EniQuantityinteger

The maximum number of ENIs per instance.

3
EniTrunkSupportedboolean

Indicates whether trunk ENIs are supported.

Note This parameter is in invitational preview and is not publicly available.
true
CpuSpeedFrequencyfloat

The CPU base frequency. Unit: GHz.

2.7
CpuTurboFrequencyfloat

The CPU turbo frequency. Unit: GHz.

3.5
PhysicalProcessorModelstring

The CPU model.

Intel Xeon(Ice Lake) Platinum 8369B
NetworkEncryptionSupportboolean

Indicates whether to allow network traffic transmitted over virtual private clouds (VPCs) to be encrypted. Valid values:

  • true
  • false
true
InstanceCategorystring

The category of the instance type. Valid values:

  • General-purpose
  • Compute-optimized
  • Memory-optimized
  • Big data
  • Local SSDs
  • High Clock Speed
  • Enhanced
  • Shared
  • Compute-optimized with GPU
  • Visual Compute-optimized
  • Heterogeneous Service
  • Compute-optimized with FPGA
  • Compute-optimized with NPU
  • ECS Bare Metal
  • Super Computing Cluster
  • High Performance Compute
Big data
CpuArchitecturestring

The CPU architecture. Valid values:

  • X86
  • ARM
X86
GPUMemorySizefloat

The amount of GPU memory per GPU. Unit: GiB

32
NetworkCardQuantityinteger

The maximum number of network cards that the instance type supports.

1
NetworkCardsarray<object>

The information about the network cards.

NetworkCardInfoobject

The information about the network card.

NetworkCardIndexinteger

The index of the network card.

1
SupportedBootModesarray

The boot modes supported by the instance type.

SupportedBootModestring

The boot mode. Valid values:

  • BIOS
  • UEFI
BIOS
EnhancedNetworkobject
Note This parameter is not publicly available.
SriovSupportboolean
Note This parameter is not publicly available.
true
VfQueueNumberPerEniinteger
Note This parameter is not publicly available.
5
CpuOptionsobject

The CPU options.

SupportedTopologyTypesarray

The CPU topology types of the instance type.

SupportedTopologyTypestring

The CPU topology type of the instance type. Valid values:

  • ContinuousCoreToHTMapping: The Hyper-Threading (HT) technology allows continuous threads to run on the same core.
  • DiscreteCoreToHTMapping: The HT technology allows discrete threads to run on the same core.
ContinuousCoreToHTMapping
NextTokenstring

The query token returned in this call.

e71d8a535bd9cc11

Examples

Sample success responses

JSONformat

{
  "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
        },
        "CpuOptions": {
          "SupportedTopologyTypes": {
            "SupportedTopologyType": [
              "ContinuousCoreToHTMapping"
            ]
          }
        }
      }
    ]
  },
  "NextToken": "e71d8a535bd9cc11"
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2024-11-25The response structure of the API has changedView Change Details
2024-10-31The response structure of the API has changedView Change Details
2024-07-03The response structure of the API has changedView Change Details
2024-04-24The response structure of the API has changedView Change Details
2024-04-12The request parameters of the API has changedView Change Details
2022-12-19The response structure of the API has changedView Change Details
2022-09-07The request parameters of the API has changed. The response structure of the API has changedView Change Details