vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/bms/api-ref/en-us_topic_0131036398.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

213 lines
19 KiB
HTML
Raw Blame History

<a name="EN-US_TOPIC_0131036398"></a><a name="EN-US_TOPIC_0131036398"></a>
<h1 class="topictitle1">Querying NICs Attached to a <span id="text1691592818356">BMS</span><span id="text11541193616358"></span></h1>
<div id="body1536832031327"><div class="section" id="EN-US_TOPIC_0131036398__section798482464816"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0131036398__p256675244713">This API is used to query information about NICs attached to a <span id="EN-US_TOPIC_0131036398__text14468194514358">BMS</span><span id="EN-US_TOPIC_0131036398__text16927114823512"></span>, such as the IP address and MAC address of each NIC.</p>
</div>
<div class="section" id="EN-US_TOPIC_0131036398__section641994764720"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0131036398__p1090449916610">GET /v1/{project_id}/baremetalservers/{server_id}/os-interface</p>
<div class="p" id="EN-US_TOPIC_0131036398__p177122942819"><a href="#EN-US_TOPIC_0131036398__table38523909">Table 1</a> lists the parameters.
<div class="tablenoborder"><a name="EN-US_TOPIC_0131036398__table38523909"></a><a name="table38523909"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0131036398__table38523909" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0131036398__row15247616"><th align="left" class="cellrowborder" valign="top" width="21.12%" id="mcps1.3.2.3.2.2.4.1.1"><p id="EN-US_TOPIC_0131036398__p27097356">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25.06%" id="mcps1.3.2.3.2.2.4.1.2"><p id="EN-US_TOPIC_0131036398__p47402253">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53.82%" id="mcps1.3.2.3.2.2.4.1.3"><p id="EN-US_TOPIC_0131036398__p14377323">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0131036398__row23712525"><td class="cellrowborder" valign="top" width="21.12%" headers="mcps1.3.2.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0131036398__p41666396">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="25.06%" headers="mcps1.3.2.3.2.2.4.1.2 "><p id="EN-US_TOPIC_0131036398__p19534911">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="53.82%" headers="mcps1.3.2.3.2.2.4.1.3 "><p id="EN-US_TOPIC_0131036398__p37593705">Specifies the project ID.</p>
<p id="EN-US_TOPIC_0131036398__p652825144113">For details about how to obtain the project ID, see <a href="en-us_topic_0171277624.html">Obtaining a Project ID</a>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0131036398__row45459464114812"><td class="cellrowborder" valign="top" width="21.12%" headers="mcps1.3.2.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0131036398__p6481999114812">server_id</p>
</td>
<td class="cellrowborder" valign="top" width="25.06%" headers="mcps1.3.2.3.2.2.4.1.2 "><p id="EN-US_TOPIC_0131036398__p55279920114812">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="53.82%" headers="mcps1.3.2.3.2.2.4.1.3 "><p id="EN-US_TOPIC_0131036398__p48488537114812">Specifies the <span id="EN-US_TOPIC_0131036398__text89601833183216">BMS</span><span id="EN-US_TOPIC_0131036398__text186444012328"></span> ID.</p>
<p id="EN-US_TOPIC_0131036398__p29791113277">You can obtain the BMS ID from the <span id="EN-US_TOPIC_0131036398__en-us_topic_0113746489_text013014803615">BMS</span><span id="EN-US_TOPIC_0131036398__en-us_topic_0113746489_text10131448133612"></span> console or by calling the <a href="en-us_topic_0053158693.html">Querying BMSs (Native OpenStack API)</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0131036398__section345518481507"><h4 class="sectiontitle">Request</h4><ul id="EN-US_TOPIC_0131036398__ul77286322271"><li id="EN-US_TOPIC_0131036398__li13272191514427">Request parameters<p id="EN-US_TOPIC_0131036398__p0376122019423"><a name="EN-US_TOPIC_0131036398__li13272191514427"></a><a name="li13272191514427"></a>None</p>
</li><li id="EN-US_TOPIC_0131036398__li18728632192711">Example request<div class="codecoloring" codetype="Java" id="EN-US_TOPIC_0131036398__screen51610410274"><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">//{BMS Endpoint}/v1/c685484a8cc2416b97260938705deb65/baremetalservers/95bf2490-5428-432c-ad9b-5e3406f869dd/os-interface</span>
</pre></div></td></tr></table></div>
</div>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0131036398__section9486358155019"><h4 class="sectiontitle">Response</h4><ul id="EN-US_TOPIC_0131036398__ul10539156"><li id="EN-US_TOPIC_0131036398__li32634650">Response parameters
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0131036398__table25276401" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0131036398__row30840926"><th align="left" class="cellrowborder" valign="top" width="32.46%" id="mcps1.3.4.2.1.1.1.4.1.1"><p id="EN-US_TOPIC_0131036398__p15087078">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="30.2%" id="mcps1.3.4.2.1.1.1.4.1.2"><p id="EN-US_TOPIC_0131036398__p748676">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="37.34%" id="mcps1.3.4.2.1.1.1.4.1.3"><p id="EN-US_TOPIC_0131036398__p60642794">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0131036398__row13119252"><td class="cellrowborder" valign="top" width="32.46%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0131036398__p56026474">interfaceAttachments</p>
</td>
<td class="cellrowborder" valign="top" width="30.2%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0131036398__p34453949">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="37.34%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0131036398__p18214233">Specifies <span id="EN-US_TOPIC_0131036398__text13386181011369">BMS</span><span id="EN-US_TOPIC_0131036398__text480381353614"></span> NICs. For details, see <a href="#EN-US_TOPIC_0131036398__table49805933">Table 2</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0131036398__table49805933"></a><a name="table49805933"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0131036398__table49805933" frame="border" border="1" rules="all"><caption><b>Table 2 </b><strong id="EN-US_TOPIC_0131036398__b986010466167">interfaceAttachments</strong> field data structure description</caption><thead align="left"><tr id="EN-US_TOPIC_0131036398__row9026257"><th align="left" class="cellrowborder" valign="top" width="25.81741825817418%" id="mcps1.3.4.2.1.2.2.4.1.1"><p id="EN-US_TOPIC_0131036398__p60038205">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="29.947005299470053%" id="mcps1.3.4.2.1.2.2.4.1.2"><p id="EN-US_TOPIC_0131036398__p48740201">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="44.235576442355764%" id="mcps1.3.4.2.1.2.2.4.1.3"><p id="EN-US_TOPIC_0131036398__p55642234">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0131036398__row10727144"><td class="cellrowborder" valign="top" width="25.81741825817418%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0131036398__p63592346">port_state</p>
</td>
<td class="cellrowborder" valign="top" width="29.947005299470053%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0131036398__p13579756">String</p>
</td>
<td class="cellrowborder" valign="top" width="44.235576442355764%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0131036398__p34639550">Specifies the NIC port status. The value can be <strong id="EN-US_TOPIC_0131036398__b1868813530222922">ACTIVE</strong>, <strong id="EN-US_TOPIC_0131036398__b1414577617222922">BUILD</strong>, or <strong id="EN-US_TOPIC_0131036398__b92255202222922">DOWN</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0131036398__row43320496"><td class="cellrowborder" valign="top" width="25.81741825817418%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0131036398__p19299281">fixed_ips</p>
</td>
<td class="cellrowborder" valign="top" width="29.947005299470053%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0131036398__p55265559">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="44.235576442355764%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0131036398__p23274750">Specifies private IP addresses of NICs. For details, see <a href="#EN-US_TOPIC_0131036398__table19750463">Table 3</a>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0131036398__row8146160"><td class="cellrowborder" valign="top" width="25.81741825817418%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0131036398__p55859239">net_id</p>
</td>
<td class="cellrowborder" valign="top" width="29.947005299470053%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0131036398__p10966323">String</p>
</td>
<td class="cellrowborder" valign="top" width="44.235576442355764%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0131036398__p8495130">Specifies the ID of the subnet (<strong id="EN-US_TOPIC_0131036398__b0500645203414">network_id</strong>) to which the NIC ports belong.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0131036398__row9347313"><td class="cellrowborder" valign="top" width="25.81741825817418%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0131036398__p18934887">port_id</p>
</td>
<td class="cellrowborder" valign="top" width="29.947005299470053%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0131036398__p13287175">String</p>
</td>
<td class="cellrowborder" valign="top" width="44.235576442355764%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0131036398__p22674843">Specifies the ID of the NIC port.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0131036398__row2747002"><td class="cellrowborder" valign="top" width="25.81741825817418%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0131036398__p21180630">mac_addr</p>
</td>
<td class="cellrowborder" valign="top" width="29.947005299470053%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0131036398__p50770908">String</p>
</td>
<td class="cellrowborder" valign="top" width="44.235576442355764%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0131036398__p35008393">Specifies the MAC address of the NIC.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0131036398__row897132161419"><td class="cellrowborder" valign="top" width="25.81741825817418%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0131036398__p15511740165815">driver_mode</p>
</td>
<td class="cellrowborder" valign="top" width="29.947005299470053%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0131036398__p3551204012584">String</p>
</td>
<td class="cellrowborder" valign="top" width="44.235576442355764%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0131036398__p1955112405587">Specifies the NIC driver type in Guest OS. The value can be <strong id="EN-US_TOPIC_0131036398__b7171182851216">virtio</strong> or <strong id="EN-US_TOPIC_0131036398__b1117152861212">hinic</strong>. The default value is <strong id="EN-US_TOPIC_0131036398__b817112810124">virtio</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0131036398__row2631162451417"><td class="cellrowborder" valign="top" width="25.81741825817418%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0131036398__p59012168210">pci_address</p>
</td>
<td class="cellrowborder" valign="top" width="29.947005299470053%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0131036398__p6901916024">String</p>
</td>
<td class="cellrowborder" valign="top" width="44.235576442355764%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0131036398__p9901816220">Specifies the BDF number of the NIC in Linux Guest OS.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0131036398__table19750463"></a><a name="table19750463"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0131036398__table19750463" frame="border" border="1" rules="all"><caption><b>Table 3 </b><strong id="EN-US_TOPIC_0131036398__b1699562913194">fixed_ips</strong> field data structure description</caption><thead align="left"><tr id="EN-US_TOPIC_0131036398__row60761195"><th align="left" class="cellrowborder" valign="top" width="25.937406259374065%" id="mcps1.3.4.2.1.3.2.4.1.1"><p id="EN-US_TOPIC_0131036398__p22709757">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="29.887011298870114%" id="mcps1.3.4.2.1.3.2.4.1.2"><p id="EN-US_TOPIC_0131036398__p17039762">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="44.17558244175583%" id="mcps1.3.4.2.1.3.2.4.1.3"><p id="EN-US_TOPIC_0131036398__p38043494">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0131036398__row61624137"><td class="cellrowborder" valign="top" width="25.937406259374065%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0131036398__p25499238">subnet_id</p>
</td>
<td class="cellrowborder" valign="top" width="29.887011298870114%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0131036398__p65213800">String</p>
</td>
<td class="cellrowborder" valign="top" width="44.17558244175583%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="EN-US_TOPIC_0131036398__p27784979">Specifies the ID of the subnet (<strong id="EN-US_TOPIC_0131036398__b19991312113512">subnet_id</strong>) corresponding to the private IP address of the NIC.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0131036398__row48738220"><td class="cellrowborder" valign="top" width="25.937406259374065%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0131036398__p55481787">ip_address</p>
</td>
<td class="cellrowborder" valign="top" width="29.887011298870114%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0131036398__p17532027">String</p>
</td>
<td class="cellrowborder" valign="top" width="44.17558244175583%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="EN-US_TOPIC_0131036398__p30163672">Specifies the NIC private IP address.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0131036398__li1739619610351">Example response<div class="codecoloring" codetype="Java" id="EN-US_TOPIC_0131036398__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>
<span class="normal">16</span></pre></div></td><td class="code"><div><pre><span></span><span class="p">{</span>
<span class="w"> </span><span class="s">&quot;interfaceAttachments&quot;</span><span class="p">:</span><span class="w"> </span><span class="o">[</span>
<span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="s">&quot;port_state&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;ACTIVE&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;fixed_ips&quot;</span><span class="p">:</span><span class="w"> </span><span class="o">[</span>
<span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="s">&quot;subnet_id&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;a5052101-11e1-4f3d-a5fa-f6ba6791219c&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;ip_address&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;192.168.1.147&quot;</span>
<span class="w"> </span><span class="p">}</span>
<span class="w"> </span><span class="o">]</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;net_id&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;ad0fadbf-4bc1-472c-a030-5310e53b3818&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;port_id&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;bb585b04-f2a2-4528-9064-fd0aeb4e15a9&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;mac_addr&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;fa:16:3e:3b:58:fc&quot;</span>
<span class="w"> </span><span class="p">}</span>
<span class="w"> </span><span class="o">]</span>
<span class="p">}</span>
</pre></div></td></tr></table></div>
</div>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0131036398__section868814916514"><h4 class="sectiontitle">Returned Values</h4><div class="p" id="EN-US_TOPIC_0131036398__en-us_topic_0106040941_p193201622141412">Normal values
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0131036398__en-us_topic_0106040941_table753804619176" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0131036398__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_0131036398__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_0131036398__en-us_topic_0106040941_p207355465176">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0131036398__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_0131036398__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_0131036398__en-us_topic_0106040941_p207351246161711">The request has been successfully processed.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<p id="EN-US_TOPIC_0131036398__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_0131036398__section14752650154917"><h4 class="sectiontitle">Error Codes</h4><p id="EN-US_TOPIC_0131036398__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_0131036397.html">BMS NIC Management</a></div>
</div>
</div>
View Git Blame Copy Permalink