接口功能介绍
该接口提供用户可用规格列表查询功能,可返回云主机规格的详细信息,并允许用户根据云主机规格的特殊字段进行筛选。用户可以根据此接口的返回值了解自己可使用的云主机规格有哪些。
您可以通过规格说明了解弹性云主机的选型基本信息
准备工作:
构造请求:在调用前需要了解如何构造请求,详情查看构造请求
认证鉴权:openapi请求需要进行加密调用,详细查看认证鉴权
接口约束
无
URI
POST /v4/ecs/flavor/list
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionID | 是 | String | 资源池ID,您可以查看地域和可用区来了解资源池 获取: 查 资源池列表查询 |
bb9fdb42056f11eda1610242ac110002 | |
azName | 否 | String | 可用区名称,您可以查看地域和可用区来了解可用区 获取: 查 资源池可用区查询 注:查询结果中zoneList内返回存在可用区名称(即多可用区,本字段填写实际可用区名称),若查询结果中zoneList为空(即为单可用区,本字段填写default) |
default | |
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],支持类型会随着功能升级增加 | GPU_N_PI7 | |
flavorName | 否 | String | 规格名称 | pi7.4xlarge.4 | |
flavorCPU | 否 | Integer | VCPU个数 | 16 | |
flavorRAM | 否 | Integer | 内存大小,单位为GB | 32 | |
flavorArch | 否 | String | 指令集架构 | x86 | |
flavorSeries | 否 | String | 规格系列 | g | |
flavorID | 否 | String | 云主机规格ID,您可以通过规格说明了解弹性云主机的选型基本信息 |
f02916cc-0445-be64-5e41-64019e95dc07 |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 返回状态码(800为成功,900为失败) | 800 | |
errorCode | String | 错误码,为product.module.code三段式码 | Openapi.PatternCheck.NotValid | |
error | String | 错误码,为product.module.code三段式码 | Openapi.PatternCheck.NotValid | |
description | String | 失败时的错误描述,一般为中文描述 | ||
returnObj | Object | 返回内容 | returnObj |
表 returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
flavorList | Array of Objects | 规格列表 | flavorList |
表 flavorList
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
cpuInfo | String | cpu架构 | x86 | |
baseBandwidth | Float | 基准带宽 | 7.5 | |
flavorName | String | 云主机规格名称 | pi7.4xlarge.4 | |
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],支持类型会随着功能升级增加 | GPU_N_PI7 | |
flavorSeries | String | 云主机规格系列,规格系列说明: s(通用性), c(计算增强型), m(内存优化型), hs(海光通用型), hc(海光计算增强型), hm(海光内存优化型), fs(飞腾通用型), fc(飞腾计算增强型), fm(飞腾内存优化型), ks(鲲鹏通用型), kc(鲲鹏计算增强型), kc(鲲鹏内存优化型), p(GPU计算加速型), g(GPU图像加速基础型), ip3(超高IO型) |
s | |
nicMultiQueue | Integer | 网卡多队列数目 | 8 | |
pps | Integer | 最大收发包限制 | 0 | |
flavorCPU | Integer | VCPU个数 | 16 | |
flavorRAM | Integer | 内存 | 64 | |
bandwidth | Float | 带宽 | 17 | |
flavorID | String | 云主机规格ID | f02916cc-0445-be64-5e41-64019e95dc07 | |
gpuVendor | String | GPU厂商 | NVIDIA | |
videoMemSize | Integer | GPU显存大小 | 24 | |
gpuType | String | GPU类型,取值范围:T4、V100、V100S、A10、A100、atlas 300i pro、mlu370-s4,支持类型会随着功能升级增加 | A10 | |
gpuCount | Integer | GPU设备数量 | 1 | |
available | Boolean | 是否可用(true:可用;false:不可用,已售罄) | true | |
azList | Array of Strings | 多az名称列表(非多可用区为["default"]) | ["default"] | |
flavorSeriesName | String | 规格系列名称,参照参数flavorSeries说明 | 通用型 |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
{
"regionID":"81f77286xxxxxxxxxd5b",
"azName": "az1",
"flavorID": "f02916cc-0445-be64-5e41-64019e95dc07",
"flavorSeries": "g"
}
响应示例
{
"returnObj": {
"flavorList": [{
"gpuVendor": "NVIDIA",
"cpuInfo": "x86",
"baseBandwidth": 7.5,
"flavorName": "pi7.4xlarge.4",
"videoMemSize": 24,
"flavorType": "GPU_N_PI7",
"flavorSeries": "g",
"flavorRAM": 64,
"nicMultiQueue": 8,
"pps": null,
"flavorCPU": 16,
"bandwidth": 17,
"gpuType": "A10",
"flavorID": "f02916cc-0445-be64-5e41-64019e95dc07",
"gpuCount": 1,
"available": true,
"azList": ["default"],
"flavorSeriesName": "GPU计算加速型"
}]
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
请参考 状态码
错误码
请参考 错误码