查询指定规格族下的云主机信息
接口功能介绍
该接口提供用户根据指定规格族查询云主机的名称、云主机id及规格详情
接口约束
无
URI
POST /v4/ecs/flavor/list-by-families
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionID | 是 | String | 资源池ID,您可以调用regionID查看最新的天翼云资源池列表 | 888888c8888888e8a8888888ac888888 | |
azName | 否 | String | 可用区名称。您可以调用获取资源池信息,查询结果中zoneList内返回存在可用区名称(即多可用区,本字段填写实际可用区名称),若查询结果中zoneList为空(即为单可用区,本字段填写default)。 | az2 | |
flavorFamily | 是 | String | 规格族名称,可根据查询云主机规格族列表进行查询 | s7 | |
pageNo | 否 | Integer | 页码,取值范围:大于等于1,默认值为1 | 1 | |
pageSize | 否 | Integer | 每页记录数目,取值范围:[1~50],默认值为10,单页最大记录不超过50 | 10 |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 返回状态码(800为成功,900为失败)默认值:800 | 800 | |
errorCode | String | 业务细分码,为product.module.code三段式码,详见错误码说明 | ||
message | String | 失败时的错误描述,一般为英文描述 | ||
description | String | 失败时的错误描述,一般为中文描述 | ||
returnObj | Object | 返回参数 | returnObj |
表 returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
currentCount | Integer | 当前页记录数目 | 1 | |
totalCount | Integer | 总记录数 | 10 | |
totalPage | Integer | 总页数 | 1 | |
results | Array of Objects | 云主机列表 | results |
表 results
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
instanceID | String | 云主机ID | b837fbc7-c359-cd2b-7687-d8f648b12832 | |
instanceName | String | 云主机名称 | ecm-ccf5 | |
flavor | Object | 云主机规格详情 | flavor |
表 flavor
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
flavorID | String | 规格ID | 8f8ba888-88e8-ea88-ea8b-888888dded88 | |
flavorName | String | 规格名称 | s7.medium.2 | |
flavorCPU | Integer | VCPU个数 | 1 | |
flavorRAM | Integer | 内存 | 2048 | |
gpuType | String | GPU类型,取值范围:T4、V100、V100S、A10、A100、atlas 300i pro、mlu370-s4,支持类型会随着功能升级增加 | ||
gpuCount | Integer | GPU数目 | 1 | |
gpuVendor | String | GPU厂商 | ||
videoMemSize | Integer | GPU显存大小 |
请求示例
请求头header
无
请求体body
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"flavorFamily": "s2",
"pageSize":10,
"pageNo":3
}
响应示例
{
"returnObj": {
"currentCount": 2,
"totalCount": 22,
"totalPage": 3,
"results": [
{
"instanceID": "acd053a3-23c6-6311-a656-15aef1e7191e",
"instanceName": "ecm-3d08",
"flavor": {
"flavorID": "dac5b373-8207-a36c-6378-48999ad718e8",
"gpuVendor": null,
"flavorName": "s2.large.4",
"flavorRAM": 8192,
"flavorCPU": 2,
"videoMemSize": null,
"gpuType": null,
"gpuCount": null
}
},
{
"instanceID": "31a4bc23-2fd9-4924-91a7-5d7c9bbd4bfa",
"instanceName": "ecm-4b18",
"flavor": {
"flavorID": "b1ed60b0-5825-4309-a797-2fa6f63deafc",
"gpuVendor": null,
"flavorName": "s2.small.1",
"flavorRAM": 1024,
"flavorCPU": 1,
"videoMemSize": null,
"gpuType": null,
"gpuCount": null
}
}
]
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
状态码 | 描述 |
---|---|
200 | 表示请求成功 |
错误码
errorCode | 描述 |
---|---|
Openapi.PatternCheck.NotValid | 请求参数无效 |
Ecs.RegionInfo.AccessFailed | 查询资源池失败,请重试。如果多次尝试失败,请提交工单 |
Ecs.RegionInfo.DataDamaged | 查询资源池信息不符预期,请重试。如果多次尝试失败,请提交工单 |
Ecs.RegionInfo.Empty | 查询资源池信息为空或资源池不存在,请确认资源池ID是否有效 |
Ecs.Parameter.InvalidAzName | 资源池中不存在该azName,请确认azName是否有效 |
Openapi.EcsWorkorder.AccessFailed | 查询云主机失败,请重试。如果多次尝试失败,请提交工单 |