接口功能介绍
该接口提供用户可用规格族列表查询功能,每种规格族代表不同种类的云主机规格,用户可以根据此接口的返回值了解自己可使用的规格族有哪些。
云主机-二代机:X86云主机,包含通用型s2、内存优化型m2。s2、m2实例规格簇均为cpu共享型,上线时间较早。
云主机-三代机:X86云主机,包含通用型S3、计算增强型c3、内存优化型m3。S3实例规格簇为cpu共享型,c3、m3实例规格簇为cpu独享,软硬件升级,性能增强。
云主机-六代机:X86云主机,包含通用型s6、通用计算增强c6、内存优化型m6。S6实例规格簇为cpu共享型,c6、m6实例规格簇为cpu独享,性能优良,能承载不同业务需求。
云主机-七代机:X86云主机,包含通用型s7、通用计算增强c7、内存优化型m7。通用型S7实例规格簇为cpu共享型,c7、m7实例规格簇为cpu独享,提供更大规格更优性能,能满足更高业务需要。
国产化云主机:X86与ARM云主机,包含鲲鹏计算增强型kc1、海光计算增强型hc1、飞腾计算增强型fc1、鲲鹏内存优化型km1、海光内存优化型hm1、飞腾内存优化型fm1,对安全性有较高要求的政府或企业应用。
本地盘云主机:X86云主机,包含云主机规格(ip3),提供数据盘为本地盘的云主机。
GPU云主机:包含图形加速基础型G5、图形加速基础型G7;计算加速型P2V、计算加速型PI7、计算加速型P8A、计算加速型PS4、计算加速型PI3、计算加速型PI2;图形加速基础型G6、图形加速基础型G7。
准备工作:
构造请求:在调用前需要了解如何构造请求,详情查看构造请求
认证鉴权:openapi请求需要进行加密调用,详细查看认证鉴权
接口约束
无
URI
GET /v4/ecs/flavor-families/list
路径参数
无
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionID | 是 | String | 资源池ID,您可以查看地域和可用区来了解资源池 获取: 查 资源池列表查询 |
533649c8eb9a11ebb25f0242ac110008 | |
azName | 是 | String | 可用区名称,您可以查看地域和可用区来了解可用区 获取: 查 资源池可用区查询 注:查询结果中zoneList内返回存在可用区名称(即多可用区,本字段填写实际可用区名称),若查询结果中zoneList为空(即为单可用区,本字段填写default) |
default |
请求参数
请求头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 | 失败时的错误描述,一般为英文描述 | ||
description | String | 失败时的错误描述,一般为中文描述 | ||
returnObj | Object | 返回内容 | returnObj |
表 returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
flavorFamilyList | Array of Strings | 规格族列表 | ["g7", "fc1", "hc1", "s2", "s7", "hm1", "fm1", "m7", "m2", "p8a", "c7", "pi7"] |
枚举参数
无
请求示例
请求url
GET .../v4/ecs/flavor-families/list?regionID=81f7728662dd11ec810800155d307d5b
请求头header
无
请求体body
无
响应示例
{
"returnObj": {
"flavorFamilyList": ["g7", "fc1", "hc1", "s2", "s7", "hm1", "fm1", "m7", "m2", "p8a", "c7", "pi7"]
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
请参考 状态码
错误码
请参考 错误码