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_0053158687.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

204 lines
18 KiB
HTML
Raw Blame History

<a name="EN-US_TOPIC_0053158687"></a><a name="EN-US_TOPIC_0053158687"></a>
<h1 class="topictitle1">Querying Information About a Specified <span id="text93761115448">BMS</span><span id="text1587715133217"></span><span id="text1110544611470"></span> NIC (Native OpenStack API)</h1>
<div id="body9540645"><div class="section" id="EN-US_TOPIC_0053158687__section44739342"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0053158687__p34594790">This API is used to query information about a specified <span id="EN-US_TOPIC_0053158687__text2200955103210">BMS</span><span id="EN-US_TOPIC_0053158687__text1947382572"></span><span id="EN-US_TOPIC_0053158687__text58501751174714"></span> NIC based on the NIC ID.</p>
</div>
<div class="section" id="EN-US_TOPIC_0053158687__section901"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0053158687__p115820561697">GET /v2.1/{project_id}/servers/{server_id}/os-interface/{id}</p>
<p id="EN-US_TOPIC_0053158687__p173750514474"><a href="#EN-US_TOPIC_0053158687__table1210415012480">Table 1</a> lists the parameters.</p>
<div class="tablenoborder"><a name="EN-US_TOPIC_0053158687__table1210415012480"></a><a name="table1210415012480"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0053158687__table1210415012480" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0053158687__row110416020487"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.2.4.2.4.1.1"><p id="EN-US_TOPIC_0053158687__p588929">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_0053158687__p47703261">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_0053158687__p38758958">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0053158687__row51045024817"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.4.2.4.1.1 "><p id="EN-US_TOPIC_0053158687__p22044110">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_0053158687__p40742509">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_0053158687__p11808928">Specifies the project ID.</p>
<p id="EN-US_TOPIC_0053158687__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_0053158687__row610413044818"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.4.2.4.1.1 "><p id="EN-US_TOPIC_0053158687__p3575612917451">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_0053158687__p1056536017451">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_0053158687__p5048782717451">Specifies the <span id="EN-US_TOPIC_0053158687__text1054235953211">BMS</span><span id="EN-US_TOPIC_0053158687__text1554255916321"></span><span id="EN-US_TOPIC_0053158687__text12231201484"></span> ID.</p>
<p id="EN-US_TOPIC_0053158687__p29791113277">You can obtain the BMS ID from the <span id="EN-US_TOPIC_0053158687__en-us_topic_0113746489_text013014803615">BMS</span><span id="EN-US_TOPIC_0053158687__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>
<tr id="EN-US_TOPIC_0053158687__row210616034814"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.4.2.4.1.1 "><p id="EN-US_TOPIC_0053158687__p18774354">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_0053158687__p44327687">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_0053158687__p33772909">Specifies the ID of the NIC.</p>
<p id="EN-US_TOPIC_0053158687__p7979630184012">You can obtain the NIC ID from the <strong id="EN-US_TOPIC_0053158687__b10816166172117">NICs</strong> tab page on the <span id="EN-US_TOPIC_0053158687__text182199293316">BMS</span><span id="EN-US_TOPIC_0053158687__text1621910223311"></span><span id="EN-US_TOPIC_0053158687__text39121813134812"></span> details page or by calling the <a href="en-us_topic_0053158678.html">Querying Information About BMS NICs (Native OpenStack API)</a> API. (The NIC ID is the value of <strong id="EN-US_TOPIC_0053158687__b1348017565215">port_id</strong>).</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0053158687__section8117"><h4 class="sectiontitle">Request</h4><ul id="EN-US_TOPIC_0053158687__ul650961612429"><li id="EN-US_TOPIC_0053158687__li138034511363">Request parameters<p id="EN-US_TOPIC_0053158687__p1464955864"><a name="EN-US_TOPIC_0053158687__li138034511363"></a><a name="li138034511363"></a>None</p>
</li><li id="EN-US_TOPIC_0053158687__li185093164425">Example request<div class="codecoloring" codetype="Java" id="EN-US_TOPIC_0053158687__screen1646122554215"><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/ce531f90-199f-48c0-816c-13e38010b442</span>
</pre></div></td></tr></table></div>
</div>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0053158687__section73053"><h4 class="sectiontitle">Response</h4><ul id="EN-US_TOPIC_0053158687__ul49535170"><li id="EN-US_TOPIC_0053158687__li6570122">Response parameters
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0053158687__table59131099" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0053158687__row30342446"><th align="left" class="cellrowborder" valign="top" width="25.97%" id="mcps1.3.4.2.1.1.1.4.1.1"><p id="EN-US_TOPIC_0053158687__p59978491115233">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="23.49%" id="mcps1.3.4.2.1.1.1.4.1.2"><p id="EN-US_TOPIC_0053158687__p26419641115233">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50.54%" id="mcps1.3.4.2.1.1.1.4.1.3"><p id="EN-US_TOPIC_0053158687__p64181866115233">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0053158687__row59560431"><td class="cellrowborder" valign="top" width="25.97%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0053158687__p59665636">interfaceAttachment</p>
</td>
<td class="cellrowborder" valign="top" width="23.49%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0053158687__p20239120">Object</p>
</td>
<td class="cellrowborder" valign="top" width="50.54%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0053158687__p57477322">Specifies information about the specified <span id="EN-US_TOPIC_0053158687__text1983216693312">BMS</span><span id="EN-US_TOPIC_0053158687__text78321066336"></span><span id="EN-US_TOPIC_0053158687__text994742010481"></span> NIC. For details, see <a href="#EN-US_TOPIC_0053158687__table24005299">Table 2</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0053158687__table24005299"></a><a name="table24005299"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0053158687__table24005299" frame="border" border="1" rules="all"><caption><b>Table 2 </b><strong id="EN-US_TOPIC_0053158687__b0726032105515">interfaceAttachment</strong> field data structure description</caption><thead align="left"><tr id="EN-US_TOPIC_0053158687__row46441279"><th align="left" class="cellrowborder" valign="top" width="26.08%" id="mcps1.3.4.2.1.2.2.4.1.1"><p id="EN-US_TOPIC_0053158687__p7555195314159">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="23.599999999999998%" id="mcps1.3.4.2.1.2.2.4.1.2"><p id="EN-US_TOPIC_0053158687__p2558155381518">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50.32%" id="mcps1.3.4.2.1.2.2.4.1.3"><p id="EN-US_TOPIC_0053158687__p1456215301510">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0053158687__row64586077"><td class="cellrowborder" valign="top" width="26.08%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0053158687__p64089786">port_state</p>
</td>
<td class="cellrowborder" valign="top" width="23.599999999999998%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0053158687__p56055356">String</p>
</td>
<td class="cellrowborder" valign="top" width="50.32%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0053158687__p62165703">Specifies the status of the NIC port. The value can be <strong id="EN-US_TOPIC_0053158687__b117416109239">ACTIVE</strong>, <strong id="EN-US_TOPIC_0053158687__b37510108234">BUILD</strong>, or <strong id="EN-US_TOPIC_0053158687__b117615105233">DOWN</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0053158687__row22620416"><td class="cellrowborder" valign="top" width="26.08%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0053158687__p20314447">fixed_ips</p>
</td>
<td class="cellrowborder" valign="top" width="23.599999999999998%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0053158687__p4888719">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="50.32%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0053158687__p7106508">Specifies the IP addresses of NICs. For details, see <a href="#EN-US_TOPIC_0053158687__table53180163">Table 3</a>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0053158687__row63958576"><td class="cellrowborder" valign="top" width="26.08%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0053158687__p13262169">net_id</p>
</td>
<td class="cellrowborder" valign="top" width="23.599999999999998%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0053158687__p40009126">String</p>
</td>
<td class="cellrowborder" valign="top" width="50.32%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0053158687__p41406050">Specifies the ID of the subnet (<strong id="EN-US_TOPIC_0053158687__b1389971112239">network_id</strong>) to which the NIC ports belong.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0053158687__row37110132"><td class="cellrowborder" valign="top" width="26.08%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0053158687__p53130720">port_id</p>
</td>
<td class="cellrowborder" valign="top" width="23.599999999999998%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0053158687__p27217289">String</p>
</td>
<td class="cellrowborder" valign="top" width="50.32%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0053158687__p44289360">Specifies the ID of the NIC port.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0053158687__row63059925"><td class="cellrowborder" valign="top" width="26.08%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0053158687__p7580267">mac_addr</p>
</td>
<td class="cellrowborder" valign="top" width="23.599999999999998%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0053158687__p6466753">String</p>
</td>
<td class="cellrowborder" valign="top" width="50.32%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0053158687__p16643039">Specifies the MAC address of the NIC.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0053158687__table53180163"></a><a name="table53180163"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0053158687__table53180163" frame="border" border="1" rules="all"><caption><b>Table 3 </b><strong id="EN-US_TOPIC_0053158687__b2538104115611">fixed_ips</strong> field data structure description</caption><thead align="left"><tr id="EN-US_TOPIC_0053158687__row34896342"><th align="left" class="cellrowborder" valign="top" width="26.150000000000002%" id="mcps1.3.4.2.1.3.2.4.1.1"><p id="EN-US_TOPIC_0053158687__p720221141617">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="23.66%" id="mcps1.3.4.2.1.3.2.4.1.2"><p id="EN-US_TOPIC_0053158687__p5203141181611">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50.19%" id="mcps1.3.4.2.1.3.2.4.1.3"><p id="EN-US_TOPIC_0053158687__p9205011169">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0053158687__row66523006"><td class="cellrowborder" valign="top" width="26.150000000000002%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0053158687__p64293480112230">subnet_id</p>
</td>
<td class="cellrowborder" valign="top" width="23.66%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0053158687__p40389402112230">String</p>
</td>
<td class="cellrowborder" valign="top" width="50.19%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="EN-US_TOPIC_0053158687__p50192196112230">Specifies the ID of the subnet (<strong id="EN-US_TOPIC_0053158687__b142571652315">subnet_id</strong>) corresponding to the private IP address of the NIC.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0053158687__row12592542"><td class="cellrowborder" valign="top" width="26.150000000000002%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0053158687__p15780700112230">ip_address</p>
</td>
<td class="cellrowborder" valign="top" width="23.66%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0053158687__p3168304112230">String</p>
</td>
<td class="cellrowborder" valign="top" width="50.19%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="EN-US_TOPIC_0053158687__p27992537112230">Specifies the NIC IP address.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<ul id="EN-US_TOPIC_0053158687__ul53782872103515"><li id="EN-US_TOPIC_0053158687__li14283800103515">Example response<div class="codecoloring" codetype="Java" id="EN-US_TOPIC_0053158687__screen29667905202623"><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></pre></div></td><td class="code"><div><pre><span></span><span class="p">{</span>
<span class="w"> </span><span class="s">&quot;interfaceAttachment&quot;</span><span class="p">:</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="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;f8a6e8f8-c2ec-497c-9f23-da9616de54ef&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.3&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="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="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="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="p">}</span>
<span class="w"> </span><span class="p">}</span>
</pre></div></td></tr></table></div>
</div>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0053158687__section7610951"><h4 class="sectiontitle">Returned Values</h4><div class="p" id="EN-US_TOPIC_0053158687__en-us_topic_0106040941_p193201622141412">Normal values
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0053158687__en-us_topic_0106040941_table753804619176" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0053158687__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_0053158687__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_0053158687__en-us_topic_0106040941_p207355465176">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0053158687__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_0053158687__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_0053158687__en-us_topic_0106040941_p207351246161711">The request has been successfully processed.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<p id="EN-US_TOPIC_0053158687__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_0053158687__section14752650154917"><h4 class="sectiontitle">Error Codes</h4><p id="EN-US_TOPIC_0053158687__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