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

Usage notes

Before you call this operation, 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 specify 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, specify the NextToken parameter to perform paged queries, or specify filter conditions to filter results.
  • We recommend that you specify the MaxResults and NextToken parameters 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

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

ParameterTypeRequiredExampleDescription
ActionStringYesDescribeInstanceTypes

The operation that you want to perform. Set the value to DescribeInstanceTypes.

InstanceTypeFamilyStringNoecs.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.NStringNoecs.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.

MinimumCpuCoreCountIntegerNo2

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.
MaximumCpuCoreCountIntegerNo10

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.
MinimumMemorySizeFloatNo20

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.
MaximumMemorySizeFloatNo60

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.
MinimumGPUAmountIntegerNo3

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.
MaximumGPUAmountIntegerNo10

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.
GPUSpecStringNoNVIDIA 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.
InstanceCategoryStringNoBig data

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
CpuArchitectureStringNoX86

The CPU architecture. Valid values:

  • X86: x86
  • ARM: ARM
MinimumCpuSpeedFrequencyFloatNo2.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.
MaximumCpuSpeedFrequencyFloatNo3.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.
MinimumCpuTurboFrequencyFloatNo3.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.
MaximumCpuTurboFrequencyFloatNo4.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.
PhysicalProcessorModelStringNoIntel 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.
InstanceFamilyLevelStringNoEntryLevel

The level of the instance family. Valid values:

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

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.
MinimumInstancePpsTxLongNo15

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.
MinimumInstanceBandwidthRxIntegerNo12288

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.
MinimumInstanceBandwidthTxIntegerNo12288

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.
MinimumPrimaryEniQueueNumberIntegerNo8

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.
MinimumSecondaryEniQueueNumberIntegerNo4

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.
MinimumEniQuantityIntegerNo4

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.
MinimumQueuePairNumberIntegerNo8

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.
MinimumEriQuantityIntegerNo0

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.
MinimumEniPrivateIpAddressQuantityIntegerNo2

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.
MinimumEniIpv6AddressQuantityIntegerNo2

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.
MinimumLocalStorageAmountIntegerNo4

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.
MinimumLocalStorageCapacityLongNo40

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

MinimumDiskQuantityIntegerNo4

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.
LocalStorageCategoryStringNolocal_ssd_pro

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 used by d1ne or d1 instances
  • local_ssd_pro: local Non-Volatile Memory Express (NVMe) SSDs, which are used by i2, i2g, i1, ga1, or gn5 instances
NvmeSupportStringNorequired

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

  • required: The cloud disk can be attached by using the NVMe protocol.
  • unsupported: The cloud disk cannot be attached by using the NVMe protocol.
MinimumBaselineCreditIntegerNo12

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.
MinimumInitialCreditIntegerNo12

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.
MaxResultsLongNo10

The maximum number of entries to return on each page. Maximum value: 1600.

Default value: 1600.

NextTokenStringNoe71d8a535bd9cc11

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.

Response parameters

ParameterTypeExampleDescription
RequestIdString00827261-20B7-4562-83F2-4DF39876A45A

The ID of the request.

InstanceTypesArray of InstanceType

Details about the instance types.

InstanceType
EniTotalQuantityInteger0

The maximum number of NICs, including the primary NIC, ENIs, and trunk NICs.

Note This parameter is in invitational preview and unavailable for general users.
LocalStorageCategoryStringlocal_ssd_pro

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

  • local_hdd_pro: local SATA HDDs, which are used by d1ne or d1 instances
  • local_ssd_pro: local NVMe SSDs, which are used by i2, i2g, i1, ga1, or gn5 instances
PrimaryEniQueueNumberInteger4

The default number of queues per primary NIC.

MemorySizeFloat16

The memory size. Unit: GiB.

LocalStorageCapacityLong5000

The capacity of each local disk. Unit: GiB.

InstanceFamilyLevelStringEnterpriseLevel

The level of the instance family. Valid values:

  • EntryLevel: entry level (shared).
  • EnterpriseLevel: enterprise level.
  • CreditEntryLevel: credit-based entry level. For more information about instance families of this level, see Overview.
InstancePpsRxLong500000

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

EniIpv6AddressQuantityInteger1

The maximum number of IPv6 addresses per ENI.

MaximumQueueNumberPerEniInteger4

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

InstanceTypeIdStringecs.g6.large

The ID of the instance type.

InstanceBandwidthRxInteger1024000

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

SecondaryEniQueueNumberInteger4

The default number of queues supported by the secondary ENI.

GPUSpecStringNVIDIA V100

The GPU model.

InstanceBandwidthTxInteger1024000

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

QueuePairNumberInteger22

The maximum number of QP queues per ERI.

EriQuantityInteger0

The number of ERIs.

Note This parameter is in invitational preview and unavailable for general users.
GPUAmountInteger0

The number of GPUs.

TotalEniQueueQuantityInteger12

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

NvmeSupportStringunsupported

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

  • required: The cloud disk can be attached by using the NVMe protocol.
  • unsupported: The cloud disk cannot be attached by using the NVMe protocol.
DiskQuantityInteger17

The maximum number of cloud disks per instance.

InitialCreditInteger120

The initial vCPU credits of a t5 or t6 burstable instance.

LocalStorageAmountInteger1

The number of local disks per instance.

BaselineCreditInteger4

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

InstancePpsTxLong500000

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

EniPrivateIpAddressQuantityInteger10

The maximum number of IPv4 addresses per ENI.

CpuCoreCountInteger4

The number of vCPUs.

InstanceTypeFamilyStringecs.g6

The instance family.

EniQuantityInteger3

The maximum number of ENIs.

EniTrunkSupportedBooleantrue

Indicates whether NICs on instances of the instance type support trunking.

Note This parameter is in invitational preview and unavailable for general users.
CpuSpeedFrequencyFloat2.7

The CPU base frequency. Unit: GHz.

CpuTurboFrequencyFloat3.5

The CPU turbo frequency. Unit: GHz.

PhysicalProcessorModelStringIntel Xeon(Ice Lake) Platinum 8369B

The CPU model.

NetworkEncryptionSupportBooleantrue

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

  • true: allows network traffic transmitted over VPCs to be encrypted.
  • false: does not allow network traffic transmitted over VPCs to be encrypted.
InstanceCategoryStringBig data

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: SCC instance type
CpuArchitectureStringX86

The CPU architecture. Valid values:

  • X86: x86
  • ARM: ARM
GPUMemorySizeFloat32

The amount of GPU memory per GPU. Unit: GiB.

NetworkCardQuantityInteger1

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

NetworkCardsArray of NetworkCardInfo

Details about the network cards.

NetworkCardInfo
NetworkCardIndexInteger1

The index of the network card.

NextTokenStringe71d8a535bd9cc11

The query token that is 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.