Queries all instance types provided by Elastic Compute Service (ECS) or information about a specific instance type.

Description

Before you call this operation, take note of the following items:

  • We recommend that you set the MaxResults and NextToken parameters for paginated queries. When you call the DescribeInstanceTypes operation to retrieve a set of results, set MaxResults to specify the maximum number of results to return in a single page for this call. If the number of results exceeds the specified MaxResults value, a NextToken is included in the response so that the remaining results can be retrieved. In a subsequent call, use the NextToken value returned in the previous response as the value of the NextToken parameter and set MaxResults to retrieve the next set 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 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

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, see DescribeInstanceTypeFamilies.

For more information about instance families, see instance families.

MaxResults Long No 10

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

Default value: 1600.

NextToken String No e71d8a535bd9cc11

The pagination token. Set the value to the NextToken value returned in the previous call of the DescribeInstanceTypes operation. Leave this parameter empty when you call this operation for the first time.

InstanceTypes.N String No ecs.g6.large

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

Response parameters

Parameter Type Example Description
RequestId String 00827261-20B7-4562-83F2-4DF39876A45A

The ID of the request.

InstanceTypes Array of InstanceType

Details of the instance types.

InstanceType
EniTotalQuantity Integer 0
Note This parameter is in invitational preview and unavailable.
LocalStorageCategory String local_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 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
PrimaryEniQueueNumber Integer 4

The default number of queues supported by the primary elastic network interface (ENI).

MemorySize Float 16

The memory size. Unit: GiB.

LocalStorageCapacity Long 5000

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

InstanceFamilyLevel String EnterpriseLevel

The level of the instance family. Valid values:

  • EntryLevel
  • EnterpriseLevel
  • CreditEntryLevel 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.

InstanceTypeId String ecs.g6.large

The ID of the instance type.

InstanceBandwidthRx Integer 1024000

The maximum inbound bandwidth. Unit: Kbit/s

SecondaryEniQueueNumber Integer 4

The default number of queues supported by the secondary ENI.

GPUSpec String NVIDIA V100

The GPU type.

InstanceBandwidthTx Integer 1024000

The maximum outbound bandwidth. Unit: Kbit/s

QueuePairNumber Integer 22

The maximum number of queue pairs (QPs) per elastic RDMA interface (ERI).

EriQuantity Integer 0

The number of ERIs.

Note This parameter is in invitational preview and unavailable.
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 nonvolatile memory express (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.
DiskQuantity Integer 17

The maximum number of cloud disks that can be attached per instance.

InitialCredit Integer 120

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

LocalStorageAmount Integer 1

The number of local disks attached per instance.

BaselineCredit Integer 4

The baseline vCPU computing performance (overall computing 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 private IP 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 that can be bound to an instance.

EniTrunkSupported Boolean true
Note This parameter is in invitational preview and unavailable.
NextToken String e71d8a535bd9cc11

The pagination 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>
        </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
    } ]
  }
}

Error codes

For a list of error codes, visit the API Error Center.