接口功能介绍
该接口提供用户可用规格列表查询功能,可返回轻量型云主机规格的详细信息,用户可以根据此接口的返回值了解自己可使用的云主机规格有哪些。
您可以通过实例套餐了解轻量型云主机的规格套餐信息
准备工作:
构造请求:在调用前需要了解如何构造请求,详情查看构造请求
认证鉴权:openapi请求需要进行加密调用,详细查看认证鉴权
接口约束
1. 使用限制,本接口只支持在部分资源池进行公测
URI
GET /v4/ecs/lite/flavor/list
路径参数
无
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionID | 是 | String | 资源池ID,您可以查看地域和可用区来了解资源池 获取: 查 资源池列表查询 |
bb9fdb42056f11eda1610242ac110002 | |
azName | 否 | String | 可用区名称,如果是4.0资源池,必须提供可用区名称。您可以查看地域和可用区来了解可用区 获取: 查 资源池可用区查询 注:查询结果中zoneList内返回存在可用区名称(即多可用区,本字段填写实际可用区名称),若查询结果中zoneList为空(即为单可用区,无需填写本字段) |
cn-huadong1-jsnj1A-public-ctcloud | |
flavorSetType | 否 | String | 规格套餐类型,取值范围: fix:固定套餐 band:带宽套餐 |
fix |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 返回状态码(800为成功,900为失败) | 800 | |
errorCode | String | 错误码,为product.module.code三段式码 | Openapi.PatternCheck.NotValid | |
error | String | 错误码,为product.module.code三段式码 | Openapi.PatternCheck.NotValid | |
message | String | 失败时的错误描述,一般为英文描述 | SUCCESS | |
description | String | 失败时的错误描述,一般为中文描述 | 成功 | |
returnObj | Object | 成功时返回的数据 | returnObj |
表 returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
currentCount | Integer | 当前页记录数目 | 1 | |
totalCount | Integer | 总记录数 | 10 | |
totalPage | Integer | 总页数 | 1 | |
results | Array of Objects | 规格列表 | results |
表 results
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
flavorSetType | String | 规格套餐类型,取值范围: fix:固定套餐 band:带宽套餐 |
fix | |
flavorName | String | 规格套餐名称 | lite1.fix.small.1 | |
flavorSeries | String | 规格系列 | lite | |
flavorType | String | 规格类型 | CPU_LITE1 | |
flavorRAM | Integer | 内存大小,单位为G | 1 | |
flavorCPU | Integer | VCPU个数 | 1 | |
flavorBandwidth | Integer | 固定套餐带宽大小,当flavorSetType为fix时展示 | 1 | |
flavorBootDiskSize | Integer | 固定套餐系统盘大小,当flavorSetType为fix时展示 | 40 | |
flavorBandwidthList | Array of Integers | 带宽套餐带宽大小取值列表,当flavorSetType为band时展示 | [1, 2, 5, 10, 15] | |
flavorBootDiskSizeList | Array of Integers | 带宽套餐系统盘大小取值列表,当flavorSetType为band时展示 | [40, 60, 80] |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
无
响应示例
{
"returnObj": {
"currentCount": 2,
"totalCount": 2,
"totalPage": 1,
"results": [{
"flavorRAM": 1,
"flavorCPU": 1,
"flavorSetType": "fix",
"flavorBootDiskSize": 40,
"flavorSeries": "lite",
"flavorName": "lite1.fix.small.1",
"flavorBandwidth": 1,
"flavorType": "CPU_LITE1"
}, {
"flavorRAM": 16,
"flavorCPU": 8,
"flavorSetType": "band",
"flavorBandwidthList": [1, 2, 5, 10, 15],
"flavorSeries": "lite",
"flavorName": "lite1.band.2xlarge.2",
"flavorBootDiskSizeList": [40, 60, 80],
"flavorType": "CPU_LITE1"
}]
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
请参考 状态码
错误码
请参考 错误码