查询规格详情和规格扩展信息列表

功能介绍

查询云服务器规格详情信息和规格扩展信息列表。

URI

GET /v1/{project_id}/cloudservers/flavors?availability_zone={availability_zone}

参数说明请参见表1。

表1 路径参数
参数	是否必选	描述
project_id	是	项目ID。获取方法请参见获取项目ID。

表2 查询参数
参数	是否必选	参数类型	描述
availability_zone	否	String	可用区，需要指定可用区（AZ）的名称，当此字段不为空时，只返回可使用（如：normal、obt、promotion等状态）的flavor列表。请参考地区和终端节点获取。

请求消息

无

响应消息

响应参数如表3所示。

表3 响应参数
参数	参数类型	描述
flavors	Array of objects	云服务器规格列表，详情请参见表4。

表4 flavors数据结构说明
参数	参数类型	描述
id	String	云服务器规格的ID。
name	String	云服务器规格的名称。
vcpus	String	云服务器规格对应的CPU核数。
ram	Integer	云服务器规格对应的内存大小，单位为MB。
disk	String	云服务器规格对应要求系统盘大小。当前未使用该参数，缺省值为0。
swap	String	云服务器规格对应要求的交换分区大小。当前未使用该参数，缺省值为""。
OS-FLV-EXT-DATA:ephemeral	Integer	扩展属性，临时盘大小。当前未使用该参数，缺省值为0。
OS-FLV-DISABLED:disabled	Boolean	扩展属性，该云服务器规格是否禁用。当前未使用该参数，缺省值为false。
rxtx_factor	Float	云服务器可使用网络带宽与网络硬件带宽的比例。当前未使用该参数，缺省值为1.0。
rxtx_quota	String	云服务器可使用网络带宽的软限制。当前未使用该参数，缺省值为null。
rxtx_cap	String	云服务器可使用网络带宽的硬限制。当前未使用该参数，缺省值为null。
os-flavor-access:is_public	Boolean	扩展属性，flavor是否给所有租户使用。 true：表示给所有租户使用。 false：表示给指定租户使用。缺省值为true。
links	Array of objects	规格相关快捷链接地址，详情请参见表5。
os_extra_specs	Object	云服务器规格的扩展字段，详情请参见表6。
attachableQuantity	Object	云服务器可挂载网卡和卷数，详情参见表7。

表5 links字段数据结构说明
参数	参数类型	描述
rel	String	快捷链接标记名称。
href	String	对应快捷链接。
type	String	快捷链接类型，当前接口未使用，缺省值为null。

表6 os_extra_specs数据结构说明（仅列举常用参数）
参数	参数类型	描述
ecs:performancetype	String	云服务器规格的分类： normal：通用计算型 computingv3：通用计算增强型 highmem：内存优化型 cpuv1：计算I型 cpuv2：计算II型 highcpu：高性能计算型 diskintensive：磁盘增强型 saphana：超大内存型 kunpeng_highio：鲲鹏超高I/O型 kunpeng_accelerator：鲲鹏AI推理加速型 advanced_smb：通用计算型（针对Flexus X提供资源）说明：早期注册的规格该字段为hws:performancetype。 XEN实例不支持该参数。当前仅列举已呈现在控制台的规格，如需查看其他类型，请联系技术支持。
hw:numa_nodes	String	主机的物理cpu数量。（该字段是否返回根据云服务器规格而定）
resource_type	String	资源类型。resource_type是为了区分云服务器的物理主机类型。
hpet_support	String	云服务器高精度时钟是否开启，开启为true，否则为false。（该字段是否返回根据云服务器规格而定）
instance_vnic:type	String	网卡类型，值固定为“enhanced”，表示使用增强型网络的资源创建云服务器。
instance_vnic:instance_bandwidth	String	最大带宽，单位Mbps，最大值为10000。
instance_vnic:max_count	String	最大网卡个数，最大为4。
quota:local_disk	String	值格式为{type}:{count}:{size}:{safeFormat}，其中： type指磁盘类型，当前只支持hdd。 count指本地磁盘数量，目前支持： d1类型：3/6/12/24 d2类型：2/4/8/12/16/24 d3类型：2/4/8/12/16/24/28。 size指单个磁盘容量，单位GB，目前只支持1675（实际磁盘大小为1800，格式化后可用大小为1675）。 safeFormat指云服务器本地磁盘是否安全格式化，目前仅支持： d1类型：FALSE d2/d3类型：True。说明：磁盘增强型特有字段。
quota:nvme_ssd	String	值格式为{type}:{spec}:{num}:{size}:{safeFormat}，其中： type指主机上配备的nvme ssd的单卡容量大小，当前只支持1.6T/3.2T。 spec指nvme ssd的规格，包括large和lvs。large表示大规格，lvs表示小规格。目前仅支持I系列（例如i3）类型：large。 num指本地盘个数。 size指guest使用的盘的容量大小，单位为GB。在spec值为large的情况下，此项即为host单卡大小。在spec值为lvs的情况下，此值为50的整倍数。 safeFormat指云服务器本地磁盘是否安全格式化。目前仅支持I系列（例如i3）类型：True。说明：超高I/O型特有字段。
extra_spec:io:persistent_grant	String	是否支持持久化，值为true。代表云服务器访问存储的方式为持久化授权。说明：密集存储D1型特有字段。
ecs:generation	String	弹性云服务器类型的代数。示例：s3中的3表示通用型III代，详细的规格类型和代系请参考《弹性云服务器用户指南》的“实例规格清单”。
ecs:virtualization_env_types	String	虚拟化类型。如果值为“FusionCompute”，表示弹性云服务器使用基于XEN的虚拟化技术。如果值为“CloudCompute”，表示弹性云服务器使用基于KVM的虚拟化技术。说明：可选字段。
cond:operation:status	String	此参数是Region级配置，某个AZ没有在cond:operation:az参数中配置时默认使用此参数的取值。不配置或无此参数时等同于“normal”。取值范围： normal：正常商用 abandon：下线（即不显示） sellout：售罄 obt：公测 obt_sellout：公测售罄 promotion：推荐(等同normal，也是商用)
cond:operation:az	String	此参数是AZ级配置，某个AZ没有在此参数中配置时默认使用cond:operation:status参数的取值。此参数的配置格式“az(xx)”。()内为某个AZ的flavor状态，()内必须要填有状态，不填为无效配置。状态的取值范围与cond:operation:status参数相同。例如：flavor在某个region的az0正常商用，az1售罄，az2公测，az3正常商用，其他az显示下线，可配置为： “cond:operation:status”设置为“abandon” “cond:operation:az”设置为“az0(normal), az1(sellout), az2(obt), az3(normal)” 说明：如果flavor在某个AZ下的状态与cond:operation:status配置状态不同，必须配置该参数。
quota:max_rate	String	最大带宽单位Mbps，显示为Gbps时除以1000
quota:min_rate	String	基准带宽单位Mbps，显示为Gbps时除以1000
quota:max_pps	String	内网最大收发包能力单位个，显示为xx万时除以10000
cond:operation:charge:stop	String	关机是否收费关机是否计费，默认免费： charge free
cond:operation:charge	String	计费类型计费场景，不配置时都支持 period，包年/包月 demand，按需
cond:spot:operation:az	String	spot售卖信息请使用查询规格销售策略接口查询。 Flavor在竞价销售模式下显示的AZ。
cond:operation:roles	String	允许的角色匹配的用户标签（roles的op_gatexxx标签）。不设置时所有用户可见
cond:spot:operation:status	String	spot售卖信息请使用查询规格销售策略接口查询。 Flavor在竞价销售模式下的状态不配置时等同abandon normal，正常商用 abandon，下线 sellout，售罄 obt，公测，未申请时提示申请（暂不支持） private，私有，只给特定用户显示（暂不支持） test，试用/免费（暂不支持） promotion，推荐
cond:network	String	网络约束支持网络特性，不配置时以控制台默认配置为准。
cond:storage	String	存储约束支持磁盘特性，不配置时以控制台默认配置为准。 scsi，支持scsi localdisk，支持本地盘 ib，支持ib
cond:storage:type	String	支持的磁盘类型，不配置时以控制台默认配置为准。 SATA：普通IO云硬盘（已售罄） SAS：高IO云硬盘 GPSSD：通用型SSD云硬盘 SSD：超高IO云硬盘 ESSD：极速IO云硬盘 GPSSD2：通用型SSD V2云硬盘 ESSD2：极速型SSD V2云硬盘
cond:compute:live_resizable	String	计算约束 true，支持在线扩容。 false或不存在该字段，不支持在线扩容。
cond:compute	String	计算约束 autorecovery，自动恢复特性。不存在该字段，不支持自动恢复。
ecs:instance_architecture	String	该规格对应的CPU架构，且仅鲲鹏实例架构规格返回该字段。取值为arm64表示CPU架构为鲲鹏计算。
info:gpu:name	String	GPU显卡数量和名称。
info:cpu:name	String	CPU名称。
quota:gpu	String	GPU显卡名称。
quota:vif_max_num	String	云服务器最多支持绑定的弹性网卡个数。
quota:sub_network_interface_max_num	String	云服务器最多支持绑定的辅助弹性网卡个数。
network_interface:traffic_mirroring_supported	String	该规格是否支持流量镜像。
security:enclave_supported	String	该规格是否支持QingTian Enclave。
info:gpus	String	该规格的GPU卡信息。 name：GPU名称 memory_mb：GPU显存大小 count：GPU显卡数量 alias_prefix：GPU显卡内部别名
info:asic_accelerators	String	该规格的加速器信息。 name：加速器名称 memory_mb：加速器显存大小 count：加速器显卡数量 alias_prefix：加速器显卡内部别名

表7 attachableQuantity字段数据结构说明
参数	参数类型	描述
free_scsi	Integer	可挂载scsi卷数。
free_blk	Integer	可挂载vbd卷数。
free_disk	Integer	可挂载卷数。
free_nic	Integer	可挂载网卡数。

弹性云服务器规格一览表，请参见《弹性云服务器用户指南》的“实例规格”章节。

请求示例

查询云服务器规格详情信息和规格扩展信息列表。

GET https://{endpoint}/v1/{project_id}/cloudservers/flavors?availability_zone=availability_value

响应示例

{
    "flavors": [
        {
            "attachableQuantity": {
                "free_scsi": 60,
                "free_blk": 24,
                "free_disk": 60,
                "free_nic": 12
            },
            "id": "c3.2xlarge.2",
            "name": "c3.2xlarge.2",
            "vcpus": "8",
            "ram": 16384,
            "disk": "0",
            "swap": "",
            "links": [
                {
                    "rel": "self",
                    "href": "https://ecs.region.example.com/v1.0/743b4c0428d94531b9f2add666642e6b/flavors/c3.2xlarge.2",
                    "type": null
                },
                {
                    "rel": "bookmark",
                    "href": "https://ecs.region.example.com/743b4c0428d94531b9f2add666642e6b/flavors/c3.2xlarge.2",
                    "type": null
                }
            ],
            "OS-FLV-EXT-DATA:ephemeral": 0,
            "rxtx_factor": 1,
            "OS-FLV-DISABLED:disabled": false,
            "rxtx_quota": null,
            "rxtx_cap": null,
            "os-flavor-access:is_public": true,
            "os_extra_specs": {
                "ecs:virtualization_env_types": "CloudCompute",
                "ecs:generation": "c3",
                "ecs:instance_architecture":"arm64" ,
                "ecs:performancetype": "computingv3",
                "resource_type": "IOoptimizedC3_2"
            }
        }
    ]                              
}

返回值

请参考通用请求返回值。

错误码

请参考错误码。

父主题： 规格管理

上一篇：规格管理

下一篇：查询规格销售策略

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消