Querying Flavor Details and Extended Flavor Information
Function
This API is used to query BMS flavor details and extended flavor information. You can call this API to query the value of parameter baremetal:extBootType to check whether a flavor supports quick BMS provisioning.
URI
GET /v1/{project_id}/baremetalservers/flavors?availability_zone={availability_zone}
Parameter |
Mandatory |
Description |
---|---|---|
project_id |
Yes |
Specifies the project ID. For details about how to obtain the project ID, see Obtaining a Project ID. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
availability_zone |
No |
String |
Specifies the AZ name. For details, see Regions and Endpoints. |
Request Parameters
None
Example Request
1
|
GET https://{BMS Endpoint}/v1/c685484a8cc2416b97260938705deb65/baremetalservers/flavors?availability_zone=cn-north-1a |
Response Parameters
Parameter |
Type |
Description |
---|---|---|
flavors |
Array of objects |
Specifies BMS flavors. For details, see Table 3. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Specifies the ID of a BMS flavor. |
name |
String |
Specifies the name of a BMS flavor. |
vcpus |
String |
Specifies the number of CPU cores in a BMS flavor. |
ram |
Integer |
Specifies the memory size (MB) in a BMS flavor. |
disk |
String |
Specifies the system disk size in a BMS flavor. The value 0 indicates that the disk size is not limited. |
swap |
String |
This is a reserved attribute. |
OS-FLV-EXT-DATA:ephemeral |
Integer |
This is a reserved attribute. |
OS-FLV-DISABLED:disabled |
Boolean |
This is a reserved attribute. |
rxtx_factor |
Float |
This is a reserved attribute. |
rxtx_quota |
String |
This is a reserved attribute. |
rxtx_cap |
String |
This is a reserved attribute. |
os-flavor-access:is_public |
Boolean |
Specifies whether a flavor is public. false indicates a private flavor and true indicates a public flavor. |
links |
Array of objects |
Specifies shortcut links of a flavor. For details, see Table 4. |
os_extra_specs |
Object |
Specifies extended fields of a BMS flavor. For details, see Table 5. |
Parameter |
Type |
Description |
---|---|---|
rel |
String |
Specifies the shortcut link marker name. The value can be:
|
href |
String |
Specifies the corresponding shortcut link. |
type |
String |
Specifies the shortcut link type. |
Parameter |
Type |
Description |
---|---|---|
resource_type |
String |
Specifies the resource type of a flavor. |
capabilities:cpu_arch |
String |
Specifies the CPU architecture of the BMS. The value can be:
|
baremetal:disk_detail |
String |
Specifies physical disk specifications. |
capabilities:hypervisor_type |
String |
Specifies a flavor of the Ironic type. |
baremetal:__support_evs |
String |
Specifies whether a flavor supports EVS disks.
If the flavor of a BMS does not contain this parameter, EVS disks cannot be attached to the BMS. |
baremetal:extBootType |
String |
Specifies the boot source of the BMS.
|
capabilities:board_type |
String |
Specifies the type of a BMS flavor in the format of flavor abbreviation. For example, if the flavor name is physical.o2.medium, the flavor type is o2m. |
baremetal:net_num |
String |
Specifies the maximum number of NICs on the BMS. |
baremetal:netcard_detail |
String |
Specifies physical NIC specifications. |
baremetal:cpu_detail |
String |
Specifies physical CPU specifications. |
baremetal:memory_detail |
String |
Specifies physical memory specifications. |
cond:operation:status |
String |
Specifies the status of a BMS flavor. If this parameter is not set, its default value is normal.
|
cond:operation:az |
String |
Specifies the status of a BMS flavor in an AZ. This parameter takes effect AZ-wide. If an AZ is not configured in this parameter, the value of the cond:operation:status parameter is used by default. Its format is az (xx). xx indicates the status of a BMS flavor in an AZ, and it is mandatory. For example, a flavor is for commercial use in AZ0 and AZ3, sold out in AZ1, for OBT in AZ2, and is canceled in other AZs. Then, set parameters as follows:
NOTE:
Configure this parameter if the flavor status in an AZ is different from the cond:operation:status value. |
Example Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 |
{ "flavors": [ { "id": "physical.kl1.3xlarge", "name": "physical.kl1.3xlarge", "vcpus": "24", "ram": 321729, "disk": "6707", "swap": "", "links": [ { "rel": "self", "href": "https://compute.Region.dc1.domainname.com/v2/bbf1946d374b44a0a2a95533562ba954/flavors/physical.kl1.3xlarge", "type": null }, { "rel": "bookmark", "href": "https://compute.Region.dc1.domainname.com/bbf1946d374b44a0a2a95533562ba954/flavors/physical.kl1.3xlarge", "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": false, "os_extra_specs": { "capabilities:cpu_arch": "x86_64", "baremetal:disk_detail": "SAS SSD:2*800G Raid 1 + NVMe SSD Card1.6T", "capabilities:hypervisor_type": "ironic", "baremetal:__support_evs": "true", "baremetal:extBootType": "LocalDisk", "capabilities:board_type": "o2m", "baremetal:net_num": "2", "baremetal:netcard_detail": "2 x 2*10GE", "baremetal:cpu_detail": "Intel Xeon E5-2667 V4 (2*8core* 3.2 GHz)", "resource_type": "ironic", "baremetal:memory_detail": "256GB DDR4 RAM(GB)" } } ] } |
Returned Values
Returned Values |
Description |
---|---|
200 |
The request has been successfully processed. |
For details about other returned values, see Status Codes.
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot