查询轻量型云主机的规格套餐资源
接口功能介绍
该接口提供用户可用规格列表查询功能,可返回轻量型云主机规格的详细信息,用户可以根据此接口的返回值了解自己可使用的云主机规格有哪些。
接口约束
- 使用限制,本接口只支持在贵州3资源池进行公测
URI
GET /v4/ecs/lite/flavor/list
路径参数
无
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionID | 是 | String | 资源池ID,您可以调用regionID查看最新的天翼云资源池列表 | 88f8888888dd88ec888888888d888d8b | |
flavorSetType | 否 | String | 规格套餐类型,取值范围:fix:固定套餐band:带宽套餐 | fix |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 返回状态码(800为成功,900为失败) | 800 | |
errorCode | 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 | 规格列表 | flavors |
表 flavors
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
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] |
请求示例
GET .../v4/ecs/lite/flavor/list?regionID=81f7728662dd11ec810800155d307d5b
请求头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
}
状态码
状态码 | 描述 |
---|---|
200 | 表示请求成功。 |
错误码
errorCode | 描述 |
---|---|
Openapi.PatternCheck.NotValid | 请求参数无效 |
LiteEcs.RegionInfo.Empty | 查询资源池信息为空或资源池不存在,请确认资源池ID是否有效 |
LiteEcs.RegionInfo.AccessFailed | 查询资源池失败,请重试。如果多次尝试失败,请提交工单 |
LiteEcs.RegionInfo.DataDamaged | 查询资源池信息不符预期,请重试。如果多次尝试失败,请提交工单 |
LiteEcs.RegionVersion.NotSupport | 当前API不支持该资源池,请切换资源池重试 |
Openapi.FlavorAdmin.AccessFailed | 查询云主机规格失败,请重试。如果多次尝试失败,请提交工单 |
Openapi.FlavorAdmin.FormatError | 查询云主机规格信息格式错误,请重试。如果多次尝试失败,请提交工单 |