本接口主要用于查询云服务器ECS提供的所有实例规格的信息列表并关联获取实例规格的详细信息,也可根据特定条件查询指定实例规格的信息,帮助您了解不同实例规格的配置和性能,以便选择适合自己业务需求的实例。
接口说明
-
分页查询:您可以设置 MaxResults 参数以限制返回值中实例规格的条目数,如果只返回了部分被查询到的实例规格的条目数,则会同步返回 NextToken 参数值。再次调用该接口,设置上次调用该接口返回的 NextToken 参数值以及 MaxResults 参数,以实现分页查询实例规格信息。
-
若您调用该 API 时未传入 NextToken 参数进行分页获取,默认只返回第一页(不超过 100 条)数据,若需要更多数据,请您传入 NextToken 进行分页获取或传入过滤条件来限制返回的数据范围。
-
DescribeInstanceTypes 仅查询实例规格的配置和性能信息。如果您需要查询具体地域下可购买的实例规格,请使用 DescribeAvailableResource 。
-
关于使用 DescribeInstanceTypes 的最佳实践,请参见ECS 如何对比性能?。
-
如果您需要使用非售卖可见的实例规格或特别的规格需求,请提交工单。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
InstanceTypeFamily | string | 否 | 实例规格所属的实例规格族。取值请参见 DescribeInstanceTypeFamilies 。 关于实例规格族的更多信息,请参见实例规格族。 | ecs.g6 |
InstanceTypes | array | 否 | 指定的实例规格数组。数组长度:1~10。当该参数不传值时,默认查询所有实例规格的信息。 | |
string | 否 | 实例规格。 | ecs.g6.large | |
MinimumCpuCoreCount | integer | 否 | 查询实例规格时,期望最小 vCPU 内核的数目。取值范围:正整数。 说明
查询到实例规格的 vCPU 内核数目小于设定值时,系统不会返回其实例规格的信息。
| 2 |
MaximumCpuCoreCount | integer | 否 | 查询实例规格时,期望最大 vCPU 内核的数目。取值范围:正整数。 说明
查询到实例规格的 vCPU 内核数目大于设定值时,系统不会返回其实例规格的信息。
| 10 |
MinimumMemorySize | float | 否 | 查询实例规格时,期望最小内存。单位:GiB。 说明
查询到实例规格的内存大小小于设定值时,系统不会返回其实例规格的信息。
| 20 |
MaximumMemorySize | float | 否 | 查询实例规格时,期望最大内存。单位:GiB。 说明
查询到实例规格的内存大小大于设定值时,系统不会返回其实例规格的信息。
| 60 |
MinimumGPUAmount | integer | 否 | 查询实例规格时,期望最小 GPU 数目。取值范围:正整数。 说明
查询到实例规格的 GPU 数目小于设定值时,系统不会返回其实例规格的信息。
| 3 |
MaximumGPUAmount | integer | 否 | 查询实例规格时,期望最大 GPU 数目。取值范围:正整数。 说明
查询到实例规格的 GPU 数目大于设定值时,系统不会返回其实例规格的信息。
| 10 |
GPUSpec | string | 否 | GPU 类型。 说明
支持模糊匹配,如某规格的 GPU 类型为 NVIDIA V100,输入 NVIDIA 也可查询到该规格信息。
| NVIDIA V100 |
InstanceCategory | string | 否 | 实例规格分类。取值范围:
| Big data |
CpuArchitecture | string | 否 | CPU 架构。取值范围:
| X86 |
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 也可查询到该规格信息。
| Intel Xeon(Ice Lake) Platinum 8369B |
InstanceFamilyLevel | string | 否 | 实例规格族级别。取值范围:
| EntryLevel |
MinimumInstancePpsRx | long | 否 | 查询实例规格时,期望最小内网入方向网络收发包能力。单位:pps。 说明
查询到实例规格的内网入方向网络收发包能力小于设定值时,系统不会返回其实例规格的信息。
| 15 |
MinimumInstancePpsTx | long | 否 | 查询实例规格时,期望最小内网出方向网络收发包能力。单位:pps。 说明
查询到实例规格的内网出方向网络收发包能力小于设定值时,系统不会返回其实例规格的信息。
| 15 |
MinimumInstanceBandwidthRx | integer | 否 | 查询实例规格时,期望最小内网入方向带宽限制,单位:kbit/s。 说明
查询到实例规格的内网入方向带宽限制小于设定值时,系统不会返回其实例规格的信息。
| 12288 |
MinimumInstanceBandwidthTx | integer | 否 | 查询实例规格时,期望最小内网出方向带宽限制,单位:kbit/s。 说明
查询到实例规格的内网出方向带宽限制小于设定值时,系统不会返回其实例规格的信息。
| 12288 |
MinimumPrimaryEniQueueNumber | integer | 否 | 查询实例规格时,期望最小主网卡默认队列数。 说明
查询到实例规格的主网卡默认队列数小于设定值时,系统不会返回其实例规格的信息。
| 8 |
MinimumSecondaryEniQueueNumber | integer | 否 | 查询实例规格时,期望最小辅助弹性网卡默认队列数。 说明
查询到实例规格的辅助弹性网卡默认队列数小于设定值时,系统不会返回其实例规格的信息。
| 4 |
MinimumEniQuantity | integer | 否 | 查询实例规格时,期望最小支持挂载的弹性网卡上限。 说明
查询到实例规格的支持挂载的弹性网卡上限小于设定值时,系统不会返回其实例规格的信息。
| 4 |
MinimumQueuePairNumber | integer | 否 | 查询实例规格时,期望最小单块弹性 RDMA 网卡(ERI)的 QP(QueuePair)队列数上限。 说明
查询到实例规格的单块弹性 RDMA 网卡(ERI)的 QP(QueuePair)队列数上限小于设定值时,系统不会返回其实例规格的信息。
| 8 |
MinimumEriQuantity | integer | 否 | 查询实例规格时,期望最小弹性 RDMA 网卡(ERI)数量。 说明
查询到实例规格的弹性 RDMA 网卡(ERI)数量小于设定值时,系统不会返回其实例规格的信息。
| 0 |
MinimumEniPrivateIpAddressQuantity | integer | 否 | 查询实例规格时,期望最小单块弹性网卡的 IPv4 地址上限。 说明
查询到实例规格的单块弹性网卡的 IPv4 地址上限小于设定值时,系统不会返回其实例规格的信息。
| 2 |
MinimumEniIpv6AddressQuantity | integer | 否 | 查询实例规格时,期望最小单块弹性网卡的 IPv6 地址上限。 说明
查询到实例规格的单块弹性网卡的 IPv6 地址上限小于设定值时,系统不会返回其实例规格的信息。
| 2 |
MinimumLocalStorageAmount | integer | 否 | 查询实例规格时,期望最小实例挂载的本地盘的数量。 说明
查询到实例规格的实例挂载的本地盘的数量小于设定值时,系统不会返回其实例规格的信息。
| 4 |
MinimumLocalStorageCapacity | long | 否 | 实例挂载的本地盘的单盘容量。单位:GiB | 40 |
MinimumDiskQuantity | integer | 否 | 查询实例规格时,期望最小支持挂载的云盘数量上限。 说明
查询到实例规格的支持挂载的云盘数量上限小于设定值时,系统不会返回其实例规格的信息。
| 4 |
LocalStorageCategory | string | 否 | 本地盘类型。更多信息,请参见本地盘。取值范围:
| local_ssd_pro |
NvmeSupport | string | 否 | 实例规格所挂载的云盘是否支持 NVMe。取值范围:
| required |
MinimumBaselineCredit | integer | 否 | 查询实例规格时,期望最小突发性能实例 t5、t6 的基准 vCPU 计算性能(所有 vCPU 之和)。 说明
查询到实例规格的突发性能实例 t5、t6 的基准 vCPU 计算性能(所有 vCPU 之和)小于设定值时,系统不会返回其实例规格的信息。
| 12 |
MinimumInitialCredit | integer | 否 | 查询实例规格时,期望最小突发性能实例 t5、t6 的初始 vCPU 积分值。 说明
查询到实例规格的突发性能实例 t5、t6 的初始 vCPU 积分值小于设定值时,系统不会返回其实例规格的信息。
| 12 |
InstanceTypeFamilies | array | 否 | 指定查询的实例规格族数组。数组长度:1~10。 | |
string | 否 | 实例规格族。 | ["ecs.g6", "ecs.c6", … "ecs.r6"] | |
GpuSpecs | array | 否 | 指定查询的 GPU 类型数组。数组长度:1~10。 | |
string | 否 | 指定查询的 GPU 类型。 | ["NVIDIA V100", "NVIDIA T4", … "NVIDIA A10"] | |
InstanceCategories | array | 否 | 指定查询的实例规格分类数组。数组长度:1~10。 | |
string | 否 | 指定查询的实例规格分类。取值范围:
| ["General-purpose", "Compute-optimized", … "Enhanced"] | |
CpuArchitectures | array | 否 | 指定查询的 CPU 架构数组。数组长度:1~2。 | |
string | 否 | 指定查询的 CPU 架构。取值范围:
| ["X86", "ARM"] | |
PhysicalProcessorModels | array | 否 | 指定查询的处理器型号数组。数组长度:1~10。 | |
string | 否 | 指定查询的处理器型号。 | ["Intel Xeon(Ice Lake) Platinum 8369B", "Intel Xeon(Skylake) Platinum 8163", … "Intel Xeon(Cascade Lake) Platinum 8269CY"] | |
LocalStorageCategories | array | 否 | 指定的本地盘类型数组。数组长度:1~2。 | |
string | 否 | 指定查询的本地盘类型。更多信息,请参见本地盘。取值范围:
| ["local_hdd_pro", "local_ssd_pro"] | |
MaxResults | long | 否 | 分页查询时每页的最大条目数。最大值:1600 默认值:1600 | 10 |
NextToken | string | 否 | 查询凭证(Token)。取值为上一次调用该接口返回的 NextToken 参数值,初次调用接口时无需设置该参数。 | e71d8a535bd9cc11 |
返回参数
示例
正常返回示例
JSON
格式
{
"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"
]
},
"ThreadsPerCore": 2,
"Core": 2,
"CoreFactor": 2,
"HyperThreadingAdjustable": true
},
"JumboFrameSupport": true
}
]
},
"NextToken": "e71d8a535bd9cc11"
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-11-25 | OpenAPI 返回结构发生变更 | 查看变更详情 |
2024-10-31 | OpenAPI 返回结构发生变更 | 查看变更详情 |
2024-07-03 | OpenAPI 返回结构发生变更 | 查看变更详情 |
2024-04-24 | OpenAPI 返回结构发生变更 | 查看变更详情 |
2024-04-12 | OpenAPI 入参发生变更 | 查看变更详情 |
2022-12-19 | OpenAPI 返回结构发生变更 | 查看变更详情 |
2022-09-07 | OpenAPI 入参发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |