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_0053158678.html
guoyanyan 78c80b1b46 bms_api_1109 
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: guoyanyan <guoyanyan3@huawei.com>
Co-committed-by: guoyanyan <guoyanyan3@huawei.com>
2022-12-05 13:38:58 +00:00

200 lines
18 KiB
HTML
Raw Blame History

<a name="EN-US_TOPIC_0053158678"></a><a name="EN-US_TOPIC_0053158678"></a>
<h1 class="topictitle1">Querying Information About <span id="text68606276113">BMS</span><span id="text1741618112414"></span> NICs (Native OpenStack API)</h1>
<div id="body17780525"><div class="section" id="EN-US_TOPIC_0053158678__section36073588"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0053158678__p30936422">This API is used to query information about BMS NICs, such as the MAC addresses and private IP addresses.</p>
</div>
<div class="section" id="EN-US_TOPIC_0053158678__section56226836"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0053158678__p1090449916610">GET /v2.1/{project_id}/servers/{server_id}/os-interface</p>
<p id="EN-US_TOPIC_0053158678__p672523219462"><a href="#EN-US_TOPIC_0053158678__table132771041114617">Table 1</a> lists the parameters.</p>
<div class="tablenoborder"><a name="EN-US_TOPIC_0053158678__table132771041114617"></a><a name="table132771041114617"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0053158678__table132771041114617" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0053158678__row8277114114465"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.2.4.2.4.1.1"><p id="EN-US_TOPIC_0053158678__p27097356">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_0053158678__p47402253">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_0053158678__p14377323">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0053158678__row17277041134613"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.4.2.4.1.1 "><p id="EN-US_TOPIC_0053158678__p41666396">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_0053158678__p19534911">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_0053158678__p38823967">Specifies the project ID.</p>
<p id="EN-US_TOPIC_0053158678__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_0053158678__row1127715418461"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.4.2.4.1.1 "><p id="EN-US_TOPIC_0053158678__p6481999114812">server_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_0053158678__p55279920114812">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_0053158678__p48488537114812">Specifies the <span id="EN-US_TOPIC_0053158678__text184810181544">BMS</span><span id="EN-US_TOPIC_0053158678__text12848418745"></span> ID.</p>
<p id="EN-US_TOPIC_0053158678__p29791113277">You can obtain the BMS ID from the <span id="EN-US_TOPIC_0053158678__en-us_topic_0113746489_text013014803615">BMS</span><span id="EN-US_TOPIC_0053158678__en-us_topic_0113746489_text10131448133612"></span> console or using the <a href="en-us_topic_0053158693.html">Querying BMSs (Native OpenStack API)</a> API.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0053158678__section36279478"><h4 class="sectiontitle">Request</h4><ul id="EN-US_TOPIC_0053158678__ul20492465384"><li id="EN-US_TOPIC_0053158678__li163411965">Request parameters<p id="EN-US_TOPIC_0053158678__p114037441362"><a name="EN-US_TOPIC_0053158678__li163411965"></a><a name="li163411965"></a>None</p>
</li><li id="EN-US_TOPIC_0053158678__li64924613381">Example request<div class="codecoloring" codetype="Java" id="EN-US_TOPIC_0053158678__screen1211919143817"><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/servers/95bf2490-5428-432c-ad9b-5e3406f869dd/os-interface</span><span class="w"></span>
</pre></div></td></tr></table></div>
</div>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0053158678__section58079852"><h4 class="sectiontitle">Response</h4><ul id="EN-US_TOPIC_0053158678__ul10539156"><li id="EN-US_TOPIC_0053158678__li32634650">Response parameters
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0053158678__table25276401" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0053158678__row30840926"><th align="left" class="cellrowborder" valign="top" width="28.799999999999997%" id="mcps1.3.4.2.1.1.1.4.1.1"><p id="EN-US_TOPIC_0053158678__p59978491115233">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="27.38%" id="mcps1.3.4.2.1.1.1.4.1.2"><p id="EN-US_TOPIC_0053158678__p26419641115233">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="43.82%" id="mcps1.3.4.2.1.1.1.4.1.3"><p id="EN-US_TOPIC_0053158678__p64181866115233">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0053158678__row13119252"><td class="cellrowborder" valign="top" width="28.799999999999997%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0053158678__p56026474">interfaceAttachments</p>
</td>
<td class="cellrowborder" valign="top" width="27.38%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0053158678__p34453949">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="43.82%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0053158678__p18214233">Specifies information about NICs of the <span id="EN-US_TOPIC_0053158678__text81510245413">BMS</span><span id="EN-US_TOPIC_0053158678__text111516241643"></span>. For details, see <a href="#EN-US_TOPIC_0053158678__table49805933">Table 2</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0053158678__table49805933"></a><a name="table49805933"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0053158678__table49805933" frame="border" border="1" rules="all"><caption><b>Table 2 </b><strong id="EN-US_TOPIC_0053158678__b1964273820545">interfaceAttachments</strong> field data structure description</caption><thead align="left"><tr id="EN-US_TOPIC_0053158678__row9026257"><th align="left" class="cellrowborder" valign="top" width="28.799999999999997%" id="mcps1.3.4.2.1.2.2.4.1.1"><p id="EN-US_TOPIC_0053158678__p1725119981520">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="27.38%" id="mcps1.3.4.2.1.2.2.4.1.2"><p id="EN-US_TOPIC_0053158678__p1725215901512">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="43.82%" id="mcps1.3.4.2.1.2.2.4.1.3"><p id="EN-US_TOPIC_0053158678__p1325513931517">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0053158678__row10727144"><td class="cellrowborder" valign="top" width="28.799999999999997%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0053158678__p63592346">port_state</p>
</td>
<td class="cellrowborder" valign="top" width="27.38%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0053158678__p13579756">String</p>
</td>
<td class="cellrowborder" valign="top" width="43.82%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0053158678__p34639550">Specifies the status of the NIC port. The value can be <strong id="EN-US_TOPIC_0053158678__b878875920166">ACTIVE</strong>, <strong id="EN-US_TOPIC_0053158678__b179681926170">BUILD</strong>, or <strong id="EN-US_TOPIC_0053158678__b108261064171">DOWN</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0053158678__row43320496"><td class="cellrowborder" valign="top" width="28.799999999999997%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0053158678__p19299281">fixed_ips</p>
</td>
<td class="cellrowborder" valign="top" width="27.38%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0053158678__p55265559">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="43.82%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0053158678__p23274750">Specifies the NIC private IP address. For details, see <a href="#EN-US_TOPIC_0053158678__table19750463">Table 3</a>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0053158678__row8146160"><td class="cellrowborder" valign="top" width="28.799999999999997%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0053158678__p55859239">net_id</p>
</td>
<td class="cellrowborder" valign="top" width="27.38%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0053158678__p10966323">String</p>
</td>
<td class="cellrowborder" valign="top" width="43.82%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0053158678__p8495130">Specifies the ID of the subnet (<strong id="EN-US_TOPIC_0053158678__b1150020102175">network_id</strong>) to which the NIC ports belong.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0053158678__row9347313"><td class="cellrowborder" valign="top" width="28.799999999999997%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0053158678__p18934887">port_id</p>
</td>
<td class="cellrowborder" valign="top" width="27.38%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0053158678__p13287175">String</p>
</td>
<td class="cellrowborder" valign="top" width="43.82%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0053158678__p22674843">Specifies the ID of the NIC port.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0053158678__row2747002"><td class="cellrowborder" valign="top" width="28.799999999999997%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0053158678__p21180630">mac_addr</p>
</td>
<td class="cellrowborder" valign="top" width="27.38%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0053158678__p50770908">String</p>
</td>
<td class="cellrowborder" valign="top" width="43.82%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0053158678__p35008393">Specifies the MAC address of the NIC.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0053158678__table19750463"></a><a name="table19750463"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0053158678__table19750463" frame="border" border="1" rules="all"><caption><b>Table 3 </b><strong id="EN-US_TOPIC_0053158678__b729218491545">fixed_ips</strong> field data structure description</caption><thead align="left"><tr id="EN-US_TOPIC_0053158678__row60761195"><th align="left" class="cellrowborder" valign="top" width="29.18%" id="mcps1.3.4.2.1.3.2.4.1.1"><p id="EN-US_TOPIC_0053158678__p1975316192155">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="27.589999999999996%" id="mcps1.3.4.2.1.3.2.4.1.2"><p id="EN-US_TOPIC_0053158678__p9754171910158">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="43.230000000000004%" id="mcps1.3.4.2.1.3.2.4.1.3"><p id="EN-US_TOPIC_0053158678__p17562199153">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0053158678__row61624137"><td class="cellrowborder" valign="top" width="29.18%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0053158678__p25499238">subnet_id</p>
</td>
<td class="cellrowborder" valign="top" width="27.589999999999996%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0053158678__p65213800">String</p>
</td>
<td class="cellrowborder" valign="top" width="43.230000000000004%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="EN-US_TOPIC_0053158678__p27784979">Specifies the ID of the subnet (<strong id="EN-US_TOPIC_0053158678__b1673012142176">subnet_id</strong>) corresponding to the private IP address of the NIC.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0053158678__row48738220"><td class="cellrowborder" valign="top" width="29.18%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0053158678__p55481787">ip_address</p>
</td>
<td class="cellrowborder" valign="top" width="27.589999999999996%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0053158678__p17532027">String</p>
</td>
<td class="cellrowborder" valign="top" width="43.230000000000004%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="EN-US_TOPIC_0053158678__p30163672">Specifies the NIC private IP address.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<ul id="EN-US_TOPIC_0053158678__ul938945110351"><li id="EN-US_TOPIC_0053158678__li1739619610351">Example response<div class="codecoloring" codetype="Java" id="EN-US_TOPIC_0053158678__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="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="w"> </span><span class="p">{</span><span class="w"></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="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="w"> </span><span class="p">{</span><span class="w"></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;f8a6e8f8-c2ec-497c-9f23-da9616de54ef&quot;</span><span class="p">,</span><span class="w"></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.3&quot;</span><span class="w"></span>
<span class="w"> </span><span class="p">}</span><span class="w"></span>
<span class="w"> </span><span class="o">]</span><span class="p">,</span><span class="w"></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;3cb9bc59-5699-4588-a4b1-b87f96708bc6&quot;</span><span class="p">,</span><span class="w"></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;ce531f90-199f-48c0-816c-13e38010b442&quot;</span><span class="p">,</span><span class="w"></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:4c:2c:30&quot;</span><span class="w"></span>
<span class="w"> </span><span class="p">}</span><span class="w"></span>
<span class="w"> </span><span class="o">]</span><span class="w"></span>
<span class="p">}</span><span class="w"></span>
</pre></div></td></tr></table></div>
</div>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0053158678__section7610951"><h4 class="sectiontitle">Returned Values</h4><div class="p" id="EN-US_TOPIC_0053158678__en-us_topic_0106040941_p193201622141412">Normal values
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0053158678__en-us_topic_0106040941_table753804619176" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0053158678__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_0053158678__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_0053158678__en-us_topic_0106040941_p207355465176">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0053158678__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_0053158678__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_0053158678__en-us_topic_0106040941_p207351246161711">The request has been successfully processed.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<p id="EN-US_TOPIC_0053158678__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_0053158678__section14752650154917"><h4 class="sectiontitle">Error Codes</h4><p id="EN-US_TOPIC_0053158678__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_0053158711.html">BMS NIC Management</a></div>
</div>
</div>
View Git Blame Copy Permalink