DocsICP FilingConsole
首页 DescribeInstanceTypes

DescribeInstanceTypes

更新时间: 2024-01-10 09:57:28

调用DescribeInstanceTypes查询云服务器ECS提供的所有实例规格的信息，也可以查询指定实例规格的信息。

接口说明

调用接口前，您需要注意：

  • MaxResults（每页最大条目数）参数的最大值为100，对于在2022年调用过本API的用户，MaxResults参数的最大值仍为1600，在2023年11月15日及之后，我们将对所有用户的MaxResults参数的最大值缩小到100，不再支持1600，若您调用该API时未传入NextToken参数进行分页获取，默认只返回规格第一页（不超过100条）数据，若需要更多数据，请您传入NextToken进行分页获取或传入过滤条件来限制返回的数据范围。关于使用DescribeInstanceTypes的最佳实践，请参见ECS如何对比性能？。

  • 推荐您设置MaxResults与NextToken参数进行分页查询。具体使用说明：首次调用该接口时，您设置MaxResults参数以限制返回值中实例规格的条目数，如果一次调用只返回了部分被查询到的实例规格的条目数，则会同步返回NextToken参数值。您可以再次调用该接口，设置上次调用该接口返回的NextToken参数值以及MaxResults参数，以实现分页查询实例规格信息。

  • DescribeInstanceTypes仅查询实例规格的配置和性能信息。如果您需要查询具体地域下可购买的实例规格，请使用DescribeAvailableResource。

  • 如果您需要使用非售卖可见的实例规格或特别的规格需求，请提交工单联系阿里云。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称

类型

是否必选

示例值

描述
Action String 是 DescribeInstanceTypes

系统规定参数。取值：DescribeInstanceTypes。
InstanceTypeFamily String 否 ecs.g6

实例规格所属的实例规格族。取值请参见DescribeInstanceTypeFamilies。

关于实例规格族的更多信息，请参见实例规格族。
InstanceTypes.N String 否 ecs.g6.large

指定查询的实例规格。N表示可以设置多个实例规格，N的取值范围：1~10。当该参数不传值时，默认查询所有实例规格的信息。
MinimumCpuCoreCount Integer 否 2

查询实例规格时，期望最小vCPU内核的数目。取值范围：正整数。

说明 查询到实例规格的vCPU内核数目小于设定值时，系统不会返回其实例规格的信息。
MaximumCpuCoreCount Integer 否 10

查询实例规格时，期望最大vCPU内核的数目。取值范围：正整数。

说明 查询到实例规格的vCPU内核数目大于设定值时，系统不会返回其实例规格的信息。
MinimumMemorySize Float 否 20

查询实例规格时，期望最小内存。单位：GiB。

说明 查询到实例规格的内存大小小于设定值时，系统不会返回其实例规格的信息。
MaximumMemorySize Float 否 60

查询实例规格时，期望最大内存。单位：GiB。

说明 查询到实例规格的内存大小大于设定值时，系统不会返回其实例规格的信息。
MinimumGPUAmount Integer 否 3

查询实例规格时，期望最小GPU数目。取值范围：正整数。

说明 查询到实例规格的GPU数目小于设定值时，系统不会返回其实例规格的信息。
MaximumGPUAmount Integer 否 10

查询实例规格时，期望最大GPU数目。取值范围：正整数。

说明 查询到实例规格的GPU数目大于设定值时，系统不会返回其实例规格的信息。
GPUSpec String 否 NVIDIA V100

GPU类型。

说明 支持模糊匹配，如某规格的GPU类型为NVIDIA V100，输入NVIDIA也可查询到该规格信息。
InstanceCategory String 否 Big data

实例规格分类。取值范围：

  • General-purpose： 通用型。
  • Compute-optimized：计算型。
  • Memory-optimized：内存型。
  • Big data：大数据型。
  • Local SSDs ：本地SSD型。
  • High Clock Speed ：高主频型。
  • Enhanced ：增强型。
  • Shared：共享型。
  • Compute-optimized with GPU ：GPU计算型。
  • Visual Compute-optimized ：视觉计算型。
  • Heterogeneous Service ：异构服务型。
  • Compute-optimized with FPGA ：FPGA计算型。
  • Compute-optimized with NPU ：NPU计算型。
  • ECS Bare Metal ：弹性裸金属服务器。
  • Super Computing Cluster：超级计算集群。
  • High Performance Compute：高性能计算型。
  • Cloud Physical Server：云化物理服务器。
CpuArchitecture String 否 X86

CPU架构。取值范围：

  • X86。
  • ARM。
MinimumCpuSpeedFrequency Float 否 2.5

查询实例规格时，期望最小主频。

说明 查询到实例规格的主频小于设定值时，系统不会返回其实例规格的信息。
MaximumCpuSpeedFrequency Float 否 3.2

查询实例规格时，期望最大主频。

说明 查询到实例规格的主频大于设定值时，系统不会返回其实例规格的信息。
MinimumCpuTurboFrequency Float 否 3.2

查询实例规格时，期望最小睿频。

说明 查询到实例规格的睿频小于设定值时，系统不会返回其实例规格的信息。
MaximumCpuTurboFrequency Float 否 4.1

查询实例规格时，期望最大睿频。

说明 查询到实例规格的睿频大于设定值时，系统不会返回其实例规格的信息。
PhysicalProcessorModel String 否 Intel Xeon(Ice Lake) Platinum 8369B

处理器型号。

说明 支持模糊匹配，如某规格的处理器型号为Intel Xeon(Ice Lake) Platinum 8369B，输入Intel也可查询到该规格信息。
InstanceFamilyLevel String 否 EntryLevel

实例规格族级别。取值范围：

  • EntryLevel：入门级（共享型）。
  • EnterpriseLevel：企业级。
  • CreditEntryLevel：积分入门级。
MinimumInstancePpsRx Long 否 15

查询实例规格时，期望最小内网入方向网络收发包能力。单位：pps。

说明 查询到实例规格的内网入方向网络收发包能力小于设定值时，系统不会返回其实例规格的信息。
MinimumInstancePpsTx Long 否 15

查询实例规格时，期望最小内网出方向网络收发包能力。单位：pps。

说明 查询到实例规格的内网出方向网络收发包能力小于设定值时，系统不会返回其实例规格的信息。
MinimumInstanceBandwidthRx Integer 否 12288

查询实例规格时，期望最小内网入方向带宽限制，单位：kbit/s。

说明 查询到实例规格的内网入方向带宽限制小于设定值时，系统不会返回其实例规格的信息。
MinimumInstanceBandwidthTx Integer 否 12288

查询实例规格时，期望最小内网出方向带宽限制，单位：kbit/s。

说明 查询到实例规格的内网出方向带宽限制小于设定值时，系统不会返回其实例规格的信息。
MinimumPrimaryEniQueueNumber Integer 否 8

查询实例规格时，期望最小主网卡默认队列数。

说明 查询到实例规格的主网卡默认队列数小于设定值时，系统不会返回其实例规格的信息。
MinimumSecondaryEniQueueNumber Integer 否 4

查询实例规格时，期望最小辅助弹性网卡默认队列数。

说明 查询到实例规格的辅助弹性网卡默认队列数小于设定值时，系统不会返回其实例规格的信息。
MinimumEniQuantity Integer 否 4

查询实例规格时，期望最小支持挂载的弹性网卡上限。

说明 查询到实例规格的支持挂载的弹性网卡上限小于设定值时，系统不会返回其实例规格的信息。
MinimumQueuePairNumber Integer 否 8

查询实例规格时，期望最小单块弹性RDMA网卡（ERI）的QP（QueuePair）队列数上限。

说明 查询到实例规格的单块弹性RDMA网卡（ERI）的QP（QueuePair）队列数上限小于设定值时，系统不会返回其实例规格的信息。
MinimumEriQuantity Integer 否 0

查询实例规格时，期望最小弹性RDMA网卡（ERI）数量。

说明 查询到实例规格的弹性RDMA网卡（ERI）数量小于设定值时，系统不会返回其实例规格的信息。
MinimumEniPrivateIpAddressQuantity Integer 否 2

查询实例规格时，期望最小单块弹性网卡的IPv4地址上限。

说明 查询到实例规格的单块弹性网卡的IPv4地址上限小于设定值时，系统不会返回其实例规格的信息。
MinimumEniIpv6AddressQuantity Integer 否 2

查询实例规格时，期望最小单块弹性网卡的IPv6地址上限。

说明 查询到实例规格的单块弹性网卡的IPv6地址上限小于设定值时，系统不会返回其实例规格的信息。
MinimumLocalStorageAmount Integer 否 4

查询实例规格时，期望最小实例挂载的本地盘的数量。

说明 查询到实例规格的实例挂载的本地盘的数量小于设定值时，系统不会返回其实例规格的信息。
MinimumLocalStorageCapacity Long 否 40

实例挂载的本地盘的单盘容量。单位：GiB
MinimumDiskQuantity Integer 否 4

查询实例规格时，期望最小支持挂载的云盘数量上限。

说明 查询到实例规格的支持挂载的云盘数量上限小于设定值时，系统不会返回其实例规格的信息。
LocalStorageCategory String 否 local_ssd_pro

本地盘类型。更多信息，请参见本地盘。取值范围：

  • local_hdd_pro：实例规格族d1ne和d1搭载的SATA HDD本地盘。
  • local_ssd_pro：实例规格族i2、i2g、i1、ga1和gn5等搭载的NVMe SSD本地盘。
NvmeSupport String 否 required

实例规格所挂载的云盘是否支持NVMe。取值范围：

  • required：支持。表示云盘以NVMe的方式挂载。
  • unsupported：不支持。表示云盘不以NVMe的方式挂载。
MinimumBaselineCredit Integer 否 12

查询实例规格时，期望最小突发性能实例t5、t6的基准vCPU计算性能（所有vCPU之和）。

说明 查询到实例规格的突发性能实例t5、t6的基准vCPU计算性能（所有vCPU之和）小于设定值时，系统不会返回其实例规格的信息。
MinimumInitialCredit Integer 否 12

查询实例规格时，期望最小突发性能实例t5、t6的初始vCPU积分值。

说明 查询到实例规格的突发性能实例t5、t6的初始vCPU积分值小于设定值时，系统不会返回其实例规格的信息。
MaxResults Long 否 10

分页查询时每页的最大条目数。最大值：1600

默认值：1600
NextToken String 否 e71d8a535bd9cc11

查询凭证（Token）。取值为上一次调用该接口返回的NextToken参数值，初次调用接口时无需设置该参数。

返回数据

名称

类型

示例值

描述
RequestId String 00827261-20B7-4562-83F2-4DF39876A45A

请求ID。
InstanceTypes Array of InstanceType

实例规格集合。
InstanceType
EniTotalQuantity Integer 0

支持挂载的所有网卡（包括主网卡、辅助弹性网卡、中继网卡等）上限。

说明 该参数正在邀测中，暂未开放使用。
LocalStorageCategory String local_ssd_pro

本地盘类型。更多信息，请参见本地盘。可能值：

  • local_hdd_pro：实例规格族d1ne和d1搭载的SATA HDD本地盘。
  • local_ssd_pro：实例规格族i2、i2g、i1、ga1和gn5等搭载的NVMe SSD本地盘。
PrimaryEniQueueNumber Integer 4

主网卡默认队列数。
MemorySize Float 16

内存大小。单位：GiB。
LocalStorageCapacity Long 5000

实例挂载的本地盘的单盘容量。单位：GiB。
InstanceFamilyLevel String EnterpriseLevel

实例规格族级别。可能值：

  • EntryLevel：入门级（共享型）。
  • EnterpriseLevel：企业级。
  • CreditEntryLevel：积分入门级。更多信息，请参见突发性能实例。
InstancePpsRx Long 500000

内网入方向网络收发包能力。单位：pps。
EniIpv6AddressQuantity Integer 1

单块弹性网卡的IPv6地址上限。
MaximumQueueNumberPerEni Integer 4

单块弹性网卡最大队列数。包括主网卡及辅助网卡支持的队列数。
InstanceTypeId String ecs.g6.large

实例规格ID。
InstanceBandwidthRx Integer 1024000

最大内网入方向带宽限制。单位：kbit/s
SecondaryEniQueueNumber Integer 4

辅助弹性网卡默认队列数。
GPUSpec String NVIDIA V100

GPU类型。
InstanceBandwidthTx Integer 1024000

最大内网出方向带宽限制。单位：kbit/s
QueuePairNumber Integer 22

单块弹性RDMA网卡（ERI）的QP（QueuePair）队列数上限。
EriQuantity Integer 0

弹性RDMA网卡（ERI）数量。

说明 该参数正在邀测中，暂未开放使用。
GPUAmount Integer 0

GPU数量。
TotalEniQueueQuantity Integer 12

实例规格允许修改的弹性网卡队列数总配额。
NvmeSupport String unsupported

实例规格所挂载的云盘是否支持NVMe。可能值：

  • required：支持。表示云盘以NVMe的方式挂载。
  • unsupported：不支持。表示云盘不以NVMe的方式挂载。
DiskQuantity Integer 17

支持挂载的云盘数量上限。
InitialCredit Integer 120

突发性能实例t5、t6的初始vCPU积分值。
LocalStorageAmount Integer 1

实例挂载的本地盘的数量。
BaselineCredit Integer 4

突发性能实例t5、t6的基准vCPU计算性能（所有vCPU之和）。
InstancePpsTx Long 500000

内网出方向网络收发包能力。单位：pps。
EniPrivateIpAddressQuantity Integer 10

单块弹性网卡的IPv4地址上限。
CpuCoreCount Integer 4

vCPU内核数目。
InstanceTypeFamily String ecs.g6

实例规格族。
EniQuantity Integer 3

支持挂载的弹性网卡上限。
EniTrunkSupported Boolean true

实例规格所挂载的网卡是否支持中继。

说明 该参数正在邀测中，暂未开放使用。
CpuSpeedFrequency Float 2.7

CPU基频，单位GHz。
CpuTurboFrequency Float 3.5

CPU睿频，单位GHz。
PhysicalProcessorModel String Intel Xeon(Ice Lake) Platinum 8369B

处理器型号。
NetworkEncryptionSupport Boolean true

实例是否支持VPC网络流量加密，可能值：

  • true：支持VPC网络流量加密。
  • false：不支持VPC网络流量加密。
InstanceCategory String Big data

实例规格分类。可能值：

  • General-purpose： 通用型。
  • Compute-optimized：计算型。
  • Memory-optimized：内存型。
  • Big data：大数据型。
  • Local SSDs ：本地SSD型。
  • High Clock Speed ：高主频型。
  • Enhanced ：增强型。
  • Shared：共享型。
  • Compute-optimized with GPU ：GPU计算型。
  • Visual Compute-optimized ：视觉计算型。
  • Heterogeneous Service ：异构服务型。
  • Compute-optimized with FPGA ：FPGA计算型。
  • Compute-optimized with NPU ：NPU计算型。
  • ECS Bare Metal ：弹性裸金属服务器。
  • Super Computing Cluster：超级计算集群。
  • High Performance Compute：高性能计算型。
  • Cloud Physical Server：云化物理服务器。
CpuArchitecture String X86

CPU架构，可能值：

  • X86。
  • ARM。
GPUMemorySize Float 32

规格对应的单块GPU显存。单位：GiB。
NetworkCardQuantity Integer 1

实例规格支持的物理网卡数量。
NetworkCards Array of NetworkCardInfo

物理网卡信息列表。
NetworkCardInfo
NetworkCardIndex Integer 1

物理网卡索引。
NextToken String e71d8a535bd9cc11

本次调用返回的查询凭证（Token）。

示例

请求示例

https://ecs.aliyuncs.com/?Action=DescribeInstanceTypes
&InstanceTypeFamily=ecs.g6
&InstanceTypes.1=ecs.g6.large
&<公共请求参数>

正常返回示例

XML格式

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格式

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"
    } ]
  }
}

错误码

访问错误中心查看更多错误码。

阿里云首页 云服务器 ECS 相关技术圈