doc-exports/docs/bms/api-ref/en-us_topic_0114885743.html
guoyanyan c311ecafe3 bms_api_0510
Reviewed-by: Pristromskaia, Margarita <margarita.pristromskaia@t-systems.com>
Co-authored-by: guoyanyan <guoyanyan3@huawei.com>
Co-committed-by: guoyanyan <guoyanyan3@huawei.com>
2023-10-11 08:28:11 +00:00

126 lines
16 KiB
HTML

<a name="EN-US_TOPIC_0114885743"></a><a name="EN-US_TOPIC_0114885743"></a>
<h1 class="topictitle1">Querying Details About extra_specs Parameters of a <span id="text68606276113">BMS</span><span id="text20416451025"></span><span id="text129561744616"></span> Flavor (Native OpenStack API)</h1>
<div id="body1527642919723"><div class="section" id="EN-US_TOPIC_0114885743__section62221755111516"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0114885743__en-us_topic_0057973064_p57966554"><strong id="EN-US_TOPIC_0114885743__b14603486184">extra_specs</strong> parameters specify the key-value pair of a <span id="EN-US_TOPIC_0114885743__text1314320501220">BMS</span><span id="EN-US_TOPIC_0114885743__text1947382572"></span><span id="EN-US_TOPIC_0114885743__text1165822118461"></span> flavor. For example, <strong id="EN-US_TOPIC_0114885743__b194051755171918">baremetal:extBootType</strong> specifies the boot device of the <span id="EN-US_TOPIC_0114885743__text102086534213">BMS</span><span id="EN-US_TOPIC_0114885743__text720885310212"></span><span id="EN-US_TOPIC_0114885743__text83481026134613"></span>. Its value can be <strong id="EN-US_TOPIC_0114885743__b101841236235">LocalDisk</strong> (local disk) or <strong id="EN-US_TOPIC_0114885743__b1155615158232">Volume</strong> (EVS disk). If you want to check whether a flavor supports quick provisioning, you can call this API.</p>
</div>
<div class="section" id="EN-US_TOPIC_0114885743__section116617920169"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0114885743__en-us_topic_0057973064_p6399145113254">GET /v2.1/{project_id}/flavors/{flavor_id}/os-extra_specs</p>
<p id="EN-US_TOPIC_0114885743__p1161539144514"><a href="#EN-US_TOPIC_0114885743__table955744812451">Table 1</a> lists the parameters.</p>
<div class="tablenoborder"><a name="EN-US_TOPIC_0114885743__table955744812451"></a><a name="table955744812451"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0114885743__table955744812451" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0114885743__row1155794814454"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.2.4.2.4.1.1"><p id="EN-US_TOPIC_0114885743__en-us_topic_0057973064_p26298136">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.2.4.2.4.1.2"><p id="EN-US_TOPIC_0114885743__en-us_topic_0057973064_p49774232">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.2.4.2.4.1.3"><p id="EN-US_TOPIC_0114885743__en-us_topic_0057973064_p5180964">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0114885743__row13559114874517"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.4.2.4.1.1 "><p id="EN-US_TOPIC_0114885743__en-us_topic_0057973064_p35224963">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.4.2.4.1.2 "><p id="EN-US_TOPIC_0114885743__en-us_topic_0057973064_p34649765">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.4.2.4.1.3 "><p id="EN-US_TOPIC_0114885743__en-us_topic_0057973064_p55167604">Specifies the project ID.</p>
<p id="EN-US_TOPIC_0114885743__p9141450142010">For how to obtain the project ID, see <a href="https://docs.otc.t-systems.com/en-us/api/apiug/apig-en-api-180328009.html" target="_blank" rel="noopener noreferrer">Obtaining Required Information</a>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0114885743__row255944854514"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.4.2.4.1.1 "><p id="EN-US_TOPIC_0114885743__en-us_topic_0057973064_p18974100">flavor_id</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.4.2.4.1.2 "><p id="EN-US_TOPIC_0114885743__en-us_topic_0057973064_p60507121">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.4.2.4.1.3 "><p id="EN-US_TOPIC_0114885743__en-us_topic_0057973064_p2129750">Specifies the flavor ID.</p>
<p id="EN-US_TOPIC_0114885743__p1461914516495">You can obtain the flavor ID from the <span id="EN-US_TOPIC_0114885743__en-us_topic_0053158674_text374914110111">BMS</span><span id="EN-US_TOPIC_0114885743__en-us_topic_0053158674_text1749131818"></span><span id="EN-US_TOPIC_0114885743__en-us_topic_0053158674_text2096916710416"></span> console or using the <a href="en-us_topic_0053158684.html">Querying BMS Flavors (Native OpenStack API)</a> API.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0114885743__section1517812126172"><h4 class="sectiontitle">Request</h4><ul id="EN-US_TOPIC_0114885743__ul940410271509"><li id="EN-US_TOPIC_0114885743__li12658630965">Request parameters<p id="EN-US_TOPIC_0114885743__p3718342612"><a name="EN-US_TOPIC_0114885743__li12658630965"></a><a name="li12658630965"></a>None</p>
</li><li id="EN-US_TOPIC_0114885743__li740452718504">Example request<div class="codecoloring" codetype="Java" id="EN-US_TOPIC_0114885743__screen18615193505018"><div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal">1</span></pre></div></td><td class="code"><div><pre><span></span><span class="n">GET</span><span class="w"> </span><span class="n">https</span><span class="p">:</span><span class="c1">//{ECS Endpoint}/v2.1/c685484a8cc2416b97260938705deb65/flavors/physical.s2.medium/os-extra_specs</span>
</pre></div></td></tr></table></div>
</div>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0114885743__section3899184185"><h4 class="sectiontitle">Response</h4><ul id="EN-US_TOPIC_0114885743__ul230616309323"><li id="EN-US_TOPIC_0114885743__li17306123023213">Response parameters
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0114885743__en-us_topic_0057973064_table28168569" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0114885743__en-us_topic_0057973064_row26406300"><th align="left" class="cellrowborder" valign="top" width="21.95%" id="mcps1.3.4.2.1.1.1.4.1.1"><p id="EN-US_TOPIC_0114885743__p59978491115233">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="21.95%" id="mcps1.3.4.2.1.1.1.4.1.2"><p id="EN-US_TOPIC_0114885743__p26419641115233">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="56.10000000000001%" id="mcps1.3.4.2.1.1.1.4.1.3"><p id="EN-US_TOPIC_0114885743__p64181866115233">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0114885743__en-us_topic_0057973064_row46433444"><td class="cellrowborder" valign="top" width="21.95%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0114885743__en-us_topic_0057973064_p3012613">extra_specs</p>
</td>
<td class="cellrowborder" valign="top" width="21.95%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0114885743__en-us_topic_0057973064_p42695066">Object</p>
</td>
<td class="cellrowborder" valign="top" width="56.10000000000001%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0114885743__en-us_topic_0057973064_p9931138">Specifies the key-value pair of a <span id="EN-US_TOPIC_0114885743__text6300153138">BMS</span><span id="EN-US_TOPIC_0114885743__text13005314316"></span><span id="EN-US_TOPIC_0114885743__text78851437204612"></span> flavor.</p>
<ul id="EN-US_TOPIC_0114885743__ul6746628171115"><li id="EN-US_TOPIC_0114885743__li674762817111"><strong id="EN-US_TOPIC_0114885743__b1834750114010">capabilities:cpu_arch</strong>: specifies the CPU architecture of the <span id="EN-US_TOPIC_0114885743__text46223511313">BMS</span><span id="EN-US_TOPIC_0114885743__text3622651316"></span><span id="EN-US_TOPIC_0114885743__text20116142194615"></span>. The value can be <strong id="EN-US_TOPIC_0114885743__b13963733154212">x86_64</strong> (for x86 servers) or <strong id="EN-US_TOPIC_0114885743__b1622965574218">aarch64</strong> (for ARM servers).</li><li id="EN-US_TOPIC_0114885743__li6100133771112"><strong id="EN-US_TOPIC_0114885743__b15196639576">baremetal:disk_detail</strong>: specifies the disk description.</li><li id="EN-US_TOPIC_0114885743__li14162043141114"><strong id="EN-US_TOPIC_0114885743__b11843105618712">capabilities:hypervisor_type</strong>: specifies the hypervisor type. The value is fixed at <strong id="EN-US_TOPIC_0114885743__b191615141280">ironic</strong>.</li><li id="EN-US_TOPIC_0114885743__li1492125001118"><strong id="EN-US_TOPIC_0114885743__b123992302081">baremetal:__support_evs</strong>: specifies whether to support EVS disks. The value can be <strong id="EN-US_TOPIC_0114885743__b208618517912">true</strong> or <strong id="EN-US_TOPIC_0114885743__b494067494">false</strong>. If the flavor does not contain this parameter, EVS disks are not supported either.</li><li id="EN-US_TOPIC_0114885743__li1768910569111"><strong id="EN-US_TOPIC_0114885743__b1826411507919">baremetal:extBootType</strong>: specifies the boot device of the <span id="EN-US_TOPIC_0114885743__text193781491131">BMS</span><span id="EN-US_TOPIC_0114885743__text1037816914313"></span><span id="EN-US_TOPIC_0114885743__text18748115474618"></span>. The value can be <strong id="EN-US_TOPIC_0114885743__b964584291014">LocalDisk</strong> (local disk) or <strong id="EN-US_TOPIC_0114885743__b381702512106">Volume</strong> (EVS disk).</li><li id="EN-US_TOPIC_0114885743__li75173371210"><strong id="EN-US_TOPIC_0114885743__b20941920111018">baremetal:net_num</strong>: specifies the number of NICs that can be attached to a <span id="EN-US_TOPIC_0114885743__text105681112318">BMS</span><span id="EN-US_TOPIC_0114885743__text9568811236"></span><span id="EN-US_TOPIC_0114885743__text10982158184613"></span>.</li><li id="EN-US_TOPIC_0114885743__li157010213124"><strong id="EN-US_TOPIC_0114885743__b553105913112">baremetal:netcard_detail</strong>: specifies description of the NIC.</li><li id="EN-US_TOPIC_0114885743__li14681323151213"><strong id="EN-US_TOPIC_0114885743__b65187165126">baremetal:cpu_detail</strong>: specifies description of the CPU.</li><li id="EN-US_TOPIC_0114885743__li2201230111216"><strong id="EN-US_TOPIC_0114885743__b4232103119127">resource_type</strong>: specifies the resource type. The value is fixed at <strong id="EN-US_TOPIC_0114885743__b137541842141220">ironic</strong>.</li><li id="EN-US_TOPIC_0114885743__li17699133821215"><strong id="EN-US_TOPIC_0114885743__b8760174821217">baremetal:memory_detail</strong>: specifies description of the memory.</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<ul id="EN-US_TOPIC_0114885743__ul54108506184"><li id="EN-US_TOPIC_0114885743__li1641075071817">Example response<div class="codecoloring" codetype="Java" id="EN-US_TOPIC_0114885743__screen5160296420260"><div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal"> 1</span>
<span class="normal"> 2</span>
<span class="normal"> 3</span>
<span class="normal"> 4</span>
<span class="normal"> 5</span>
<span class="normal"> 6</span>
<span class="normal"> 7</span>
<span class="normal"> 8</span>
<span class="normal"> 9</span>
<span class="normal">10</span>
<span class="normal">11</span>
<span class="normal">12</span>
<span class="normal">13</span>
<span class="normal">14</span>
<span class="normal">15</span></pre></div></td><td class="code"><div><pre><span></span><span class="p">{</span>
<span class="w"> </span><span class="s">&quot;extra_specs&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="s">&quot;capabilities:cpu_arch&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;x86_64&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;baremetal:disk_detail&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;SAS 8T&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;capabilities:hypervisor_type&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;ironic&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;baremetal:__support_evs&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;true&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;baremetal:extBootType&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;LocalDisk&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;capabilities:board_type&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;s2m&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;baremetal:net_num&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;2&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;baremetal:netcard_detail&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;2*10GE&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;baremetal:cpu_detail&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;2*8coreIntel Xeon E5-2667 V43.2GHz&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;resource_type&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;ironic&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;baremetal:memory_detail&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;256GB DDR4 RAM(GB)&quot;</span>
<span class="w"> </span><span class="p">}</span>
<span class="p">}</span>
</pre></div></td></tr></table></div>
</div>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0114885743__section7610951"><h4 class="sectiontitle">Returned Values</h4><div class="p" id="EN-US_TOPIC_0114885743__en-us_topic_0106040941_p193201622141412">Normal values
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0114885743__en-us_topic_0106040941_table753804619176" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0114885743__en-us_topic_0106040941_row10735134615172"><th align="left" class="cellrowborder" valign="top" width="42.42%" id="mcps1.3.5.2.1.1.3.1.1"><p id="EN-US_TOPIC_0114885743__en-us_topic_0106040941_p19735204616177">Returned Values</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="57.58%" id="mcps1.3.5.2.1.1.3.1.2"><p id="EN-US_TOPIC_0114885743__en-us_topic_0106040941_p207355465176">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0114885743__en-us_topic_0106040941_row1473514621713"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.5.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0114885743__en-us_topic_0106040941_p13735144611178">200</p>
</td>
<td class="cellrowborder" valign="top" width="57.58%" headers="mcps1.3.5.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0114885743__en-us_topic_0106040941_p207351246161711">The request has been successfully processed.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<p id="EN-US_TOPIC_0114885743__en-us_topic_0106040941_p47633965">For details about other returned values, see <a href="en-us_topic_0053158690.html">Status Codes</a>.</p>
</div>
<div class="section" id="EN-US_TOPIC_0114885743__section14752650154917"><h4 class="sectiontitle">Error Codes</h4><p id="EN-US_TOPIC_0114885743__en-us_topic_0106040941_p10243161417491">See <a href="en-us_topic_0107541808.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="en-us_topic_0053158668.html">BMS Flavor Query</a></div>
</div>
</div>