接口功能介绍
该接口提供用户可用规格列表查询功能,可返回云主机规格的详细信息,并允许用户根据云主机规格的特殊字段进行筛选。用户可以根据此接口的返回值了解自己可使用的云主机规格有哪些。
接口约束
- 当前页面接口为旧版 API,未来根据实际使用情况可能退役,推荐使用新版本接口,新版本接口更加规范,覆盖场景更全。
URI
POST /v4/ecs/type-list
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionID | 是 | String | 资源池ID,您可以调用查询账户启用的资源池信息查看最新的天翼云资源池列表 | bb9fdb42056f11eda1610242ac110002 | |
azName | 否 | String | 可用区名称。您可以调用资源池可用区查询获取可用区信息,查询结果中zoneList内返回存在可用区名称(即多a可用区,本字段填写实际可用区名称),若查询结果中zoneList为空(即为单可用区,本字段填写default)。 | cn-huadong1-jsnj1A-public-ctcloud | |
flavorType | 否 | String | 规格类型,取值范围:[CPU、CPU_C3、CPU_C6、CPU_C7、CPU_c7ne、CPU_C8、CPU_D3、CPU_FC1、CPU_FM1、CPU_FS1、CPU_HC1、CPU_HM1、CPU_HS1、CPU_IP3、CPU_IR3、CPU_IP3_2、CPU_IR3_2、CPU_KC1、CPU_KM1、CPU_KS1、CPU_M2、CPU_M3、CPU_M6、CPU_M7、CPU_M8、CPU_S2、CPU_S3、CPU_S6、CPU_S7、CPU_S8、CPU_s8r、GPU_N_V100_V_FMGQ、GPU_N_V100_V、GPU_N_V100S_V、GPU_N_V100S_V_FMGQ、GPU_N_T4_V、GPU_N_G7_V、GPU_N_V100、GPU_N_V100_SHIPINYUN、GPU_N_V100_SUANFA、GPU_N_P2V_RENMIN、GPU_N_V100S、GPU_N_T4、GPU_N_T4_AIJISUAN、GPU_N_T4_ASR、GPU_N_T4_JX、GPU_N_T4_SHIPINYUN、GPU_N_T4_SUANFA、GPU_N_T4_YUNYOUXI、GPU_N_PI7、GPU_N_P8A、GPU_A_PAK1、GPU_C_PCH1],支持类型会随着功能升级增加 | CPU | |
flavorName | 否 | String | 规格名称 | ||
flavorCPU | 否 | Integer | VCPU个数 | 8 | |
flavorRAM | 否 | Integer | 内存大小,单位为G | 1024 | |
flavorArch | 否 | String | 指令集架构 | ||
flavorSeries | 否 | String | 云主机规格系列,取值范围: s:通用型, c:计算增强型, m:内存优化型, hs:海光通用型, hc:海光计算增强型, hm:海光内存型, fs:飞腾通用型, fc:飞腾计算增强型, fm:飞腾内存优化型, ks:鲲鹏通用型, kc:鲲鹏计算增强型, km:鲲鹏内存优化型, g:GPU图形加速基础型, p:GPU计算加速型, ip3:超高IO型 |
||
flavorID | 否 | String | 规格ID |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 返回状态码(800为成功,900为失败) | 800 | |
errorCode | String | 业务细分码,为product.module.code三段式码,详见错误码说明 | ||
message | String | 失败时的错误信息 | ||
description | String | 失败时的错误描述 | ||
returnObj | Object | 规格列表 | returnObj |
表 returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
flavors | Array of Objects | 规格列表 | flavors |
表 flavors
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
cpuinfo | String | cpu架构 | ||
bandwidth_base | Float | 基准带宽 | ||
name | String | 云主机规格名称 | ||
flavor_type | String | 规格种类 | ||
series | String | 云主机规格系列 | ||
multiqueue | Integer | 网卡多队列数目 | 8 | |
pps | Integer | 最大收发包限制 | 8 | |
vcpu | Integer | VCPU | 16 | |
ram | Integer | 内存 | 64 | |
bandwidth | Float | 带宽 | ||
id | String | 云主机规格ID | ||
gpu_name | String | GPU厂商 | ||
video_memory | Integer | GPU显存大小 | 24 | |
gpu_type | String | GPU类型,取值范围:T4、V100、V100S、A10、A100、atlas 300i pro、mlu370-s4,支持类型会随着功能升级增加 | ||
gpu_count | Integer | GPU设备数量 | 1 | |
available | Boolean | 是否可用(true:可用;false:不可用,已售罄) | true |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
{
"regionID": "81f77286xxxxxxxxxd5b",
"flavorSeries": "g"
}
响应示例
{
"returnObj": {
"flavors": [{
"gpu_name": "NVIDIA",
"cpuinfo": "x86",
"bandwidth_base": 7.5,
"name": "pi7.4xlarge.4",
"video_memory": 24,
"flavor_type": "GPU_N_PI7",
"series": "g",
"ram": 64,
"multiqueue": 8,
"pps": null,a
"vcpu": 16,
"bandwidth": 17,
"gpu_type": "A10",
"id": "f02916cc-0445-be64-5e41-64019e95dc07",
"gpu_count": 1
}]
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
请参考 状态码
错误码
请参考 错误码