查询规格详情和规格扩展信息列表
功能介绍
查询云服务器规格详情信息和规格扩展信息列表。
调试
您可以在API Explorer中调试该接口。
URI
GET /v1/{project_id}/cloudservers/flavors?availability_zone={availability_zone}
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
availability_zone |
否 |
String |
可用区，需要指定可用区（AZ）的名称，当此字段不为空时，只返回可使用（如：normal、obt、promotion等状态）的flavor列表。 请参考地区和终端节点获取。 |
请求消息
无
响应消息
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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。 |
|
links |
Array of objects |
规格相关快捷链接地址，详情请参见表5。 |
|
os_extra_specs |
Object |
云服务器规格的扩展字段，详情请参见表6。 |
|
attachableQuantity |
Object |
云服务器可挂载网卡和卷数，详情参见表7。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
rel |
String |
快捷链接标记名称。 |
|
href |
String |
对应快捷链接。 |
|
type |
String |
快捷链接类型，当前接口未使用，缺省值为null。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
ecs:performancetype |
String |
云服务器规格的分类：
说明：
早期注册的规格该字段为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}，其中：
说明：
磁盘增强型特有字段。 |
|
quota:nvme_ssd |
String |
值格式为{type}:{spec}:{num}:{size}:{safeFormat}:{挂载协议}，其中：
说明：
超高I/O型特有字段。 |
|
extra_spec:io:persistent_grant |
String |
是否支持持久化，值为true。 代表云服务器访问存储的方式为持久化授权。
说明：
密集存储D1型特有字段。 |
|
ecs:generation |
String |
弹性云服务器类型的代数。 示例：s3中的3表示通用型III代，详细的规格类型和代系请参考《弹性云服务器用户指南》的“实例规格清单”。 |
|
ecs:virtualization_env_types |
String |
虚拟化类型。
说明：
可选字段。 |
|
pci_passthrough:enable_gpu |
String |
显卡是否直通。 值为“true”，表示GPU直通。 |
|
pci_passthrough:gpu_specs |
String |
G1型和G2型云服务器应用的技术，包括GPU虚拟化和GPU直通。
|
|
pci_passthrough:alias |
String |
PCI直通设备信息，格式为PCI设备名称:数量。多个设备信息以逗号隔开。 例如nvidia-a30:1，表示携带一张A30的GPU。 |
|
cond:operation:status |
String |
此参数是Region级配置，某个AZ没有在cond:operation:az参数中配置时默认使用此参数的取值。不配置或无此参数时等同于“normal”。取值范围：
|
|
cond:operation:az |
String |
此参数是AZ级配置，某个AZ没有在此参数中配置时默认使用cond:operation:status参数的取值。此参数的配置格式“az(xx)”。()内为某个AZ的flavor状态，()内必须要填有状态，不填为无效配置。状态的取值范围与cond:operation:status参数相同。 例如：flavor在某个region的az0正常商用，az1售罄，az2公测，az3正常商用，其他az显示下线，可配置为：
说明：
如果flavor在某个AZ下的状态与cond:operation:status配置状态不同，必须配置该参数。 |
|
quota:max_rate |
String |
最大带宽
|
|
quota:min_rate |
String |
基准带宽
|
|
quota:max_pps |
String |
内网最大收发包能力
|
|
cond:operation:charge:stop |
String |
关机是否收费
|
|
cond:operation:charge |
String |
计费类型
|
|
cond:spot:operation:az |
String |
spot售卖信息请使用 查询规格销售策略 接口查询。 Flavor在竞价销售模式下显示的AZ。 |
|
cond:operation:roles |
String |
允许的角色 匹配的用户标签（roles的op_gatexxx标签）。不设置时所有用户可见 |
|
cond:spot:operation:status |
String |
spot售卖信息请使用 查询规格销售策略 接口查询。 Flavor在竞价销售模式下的状态
|
|
cond:network |
String |
网络约束 支持网络特性，不配置时以控制台默认配置为准。 |
|
cond:storage |
String |
存储约束 支持磁盘特性，不配置时以控制台默认配置为准。
|
|
cond:storage:type |
String |
支持的磁盘类型，不配置时以控制台默认配置为准。
|
|
cond:compute:live_resizable |
String |
计算约束
|
|
cond:compute |
String |
计算约束
|
|
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卡信息。
|
|
info:asic_accelerators |
String |
该规格的加速器信息。
|
请求示例
查询云服务器规格详情信息和规格扩展信息列表。
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"
}
}
]
}
返回值
请参考通用请求返回值。
错误码
请参考错误码。
