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

198 lines
16 KiB
HTML
Raw Blame History

<a name="EN-US_TOPIC_0229339178"></a><a name="EN-US_TOPIC_0229339178"></a>
<h1 class="topictitle1">Detaching NICs from a <span id="text1357020263383">BMS</span><span id="text1592782814383"></span></h1>
<div id="body1583740817489"><div class="section" id="EN-US_TOPIC_0229339178__section4187856"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0229339178__p23131803">This API is used to detach one or more NICs from a <span id="EN-US_TOPIC_0229339178__text1068204633817">BMS</span><span id="EN-US_TOPIC_0229339178__text17771552153810"></span>.</p>
<div class="note" id="EN-US_TOPIC_0229339178__note32105232163016"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="EN-US_TOPIC_0229339178__p20511637163016">The primary NIC of a <span id="EN-US_TOPIC_0229339178__text35131706395">BMS</span><span id="EN-US_TOPIC_0229339178__text39841534398"></span> has routing rules configured and cannot be detached.</p>
</div></div>
</div>
<div class="section" id="EN-US_TOPIC_0229339178__section37690705"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0229339178__p4064161162618">POST /v1/{project_id}/baremetalservers/{server_id}/nics/delete</p>
<div class="p" id="EN-US_TOPIC_0229339178__p199661218815"><a href="#EN-US_TOPIC_0229339178__table42885739">Table 1</a> lists the parameters.
<div class="tablenoborder"><a name="EN-US_TOPIC_0229339178__table42885739"></a><a name="table42885739"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0229339178__table42885739" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0229339178__row63231703"><th align="left" class="cellrowborder" valign="top" width="22.99%" id="mcps1.3.2.3.2.2.4.1.1"><p id="EN-US_TOPIC_0229339178__p21494305">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="24.69%" id="mcps1.3.2.3.2.2.4.1.2"><p id="EN-US_TOPIC_0229339178__p63317164">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="52.32%" id="mcps1.3.2.3.2.2.4.1.3"><p id="EN-US_TOPIC_0229339178__p28416672">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0229339178__row20049059"><td class="cellrowborder" valign="top" width="22.99%" headers="mcps1.3.2.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0229339178__p13361120">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="24.69%" headers="mcps1.3.2.3.2.2.4.1.2 "><p id="EN-US_TOPIC_0229339178__p8508925">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="52.32%" headers="mcps1.3.2.3.2.2.4.1.3 "><p id="EN-US_TOPIC_0229339178__p37593705">Specifies the project ID.</p>
<p id="EN-US_TOPIC_0229339178__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_0229339178__row3613092117015"><td class="cellrowborder" valign="top" width="22.99%" headers="mcps1.3.2.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0229339178__p1181501417024">server_id</p>
</td>
<td class="cellrowborder" valign="top" width="24.69%" headers="mcps1.3.2.3.2.2.4.1.2 "><p id="EN-US_TOPIC_0229339178__p1749204017024">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="52.32%" headers="mcps1.3.2.3.2.2.4.1.3 "><p id="EN-US_TOPIC_0229339178__p756915117024">Specifies the <span id="EN-US_TOPIC_0229339178__text8753165253915">BMS</span><span id="EN-US_TOPIC_0229339178__text1475365210393"></span> ID.</p>
<p id="EN-US_TOPIC_0229339178__p29791113277">You can obtain the BMS ID from the <span id="EN-US_TOPIC_0229339178__en-us_topic_0113746489_text013014803615">BMS</span><span id="EN-US_TOPIC_0229339178__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_0229339178__section3672032"><h4 class="sectiontitle">Request</h4><ul id="EN-US_TOPIC_0229339178__ul66572221"><li id="EN-US_TOPIC_0229339178__li11440597">Request parameters
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0229339178__table35856517" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0229339178__row15151670"><th align="left" class="cellrowborder" valign="top" width="20.192019201920193%" id="mcps1.3.3.2.1.1.1.5.1.1"><p id="EN-US_TOPIC_0229339178__p19325759">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18.79187918791879%" id="mcps1.3.3.2.1.1.1.5.1.2"><p id="EN-US_TOPIC_0229339178__p21882681">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.15191519151915%" id="mcps1.3.3.2.1.1.1.5.1.3"><p id="EN-US_TOPIC_0229339178__p27666764">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="41.86418641864187%" id="mcps1.3.3.2.1.1.1.5.1.4"><p id="EN-US_TOPIC_0229339178__p26415391">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0229339178__row59271898"><td class="cellrowborder" valign="top" width="20.192019201920193%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="EN-US_TOPIC_0229339178__p36294438">nics</p>
</td>
<td class="cellrowborder" valign="top" width="18.79187918791879%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="EN-US_TOPIC_0229339178__p54168362">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="19.15191519151915%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="EN-US_TOPIC_0229339178__p25561231">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="41.86418641864187%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="EN-US_TOPIC_0229339178__p44982630">Specifies the NICs to be detached. For details, see <a href="#EN-US_TOPIC_0229339178__table43212049">Table 2</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0229339178__table43212049"></a><a name="table43212049"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0229339178__table43212049" frame="border" border="1" rules="all"><caption><b>Table 2 </b><strong id="EN-US_TOPIC_0229339178__b752414419355">nics</strong> field data structure description</caption><thead align="left"><tr id="EN-US_TOPIC_0229339178__row13772373"><th align="left" class="cellrowborder" valign="top" width="20.3020302030203%" id="mcps1.3.3.2.1.2.2.5.1.1"><p id="EN-US_TOPIC_0229339178__p41820417">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18.411841184118412%" id="mcps1.3.3.2.1.2.2.5.1.2"><p id="EN-US_TOPIC_0229339178__p32010577">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.99199919991999%" id="mcps1.3.3.2.1.2.2.5.1.3"><p id="EN-US_TOPIC_0229339178__p42719917">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="41.294129412941295%" id="mcps1.3.3.2.1.2.2.5.1.4"><p id="EN-US_TOPIC_0229339178__p37761278">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0229339178__row38764716"><td class="cellrowborder" valign="top" width="20.3020302030203%" headers="mcps1.3.3.2.1.2.2.5.1.1 "><p id="EN-US_TOPIC_0229339178__p52934302">id</p>
</td>
<td class="cellrowborder" valign="top" width="18.411841184118412%" headers="mcps1.3.3.2.1.2.2.5.1.2 "><p id="EN-US_TOPIC_0229339178__p59820093">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="19.99199919991999%" headers="mcps1.3.3.2.1.2.2.5.1.3 "><p id="EN-US_TOPIC_0229339178__p13589360">String</p>
</td>
<td class="cellrowborder" valign="top" width="41.294129412941295%" headers="mcps1.3.3.2.1.2.2.5.1.4 "><p id="EN-US_TOPIC_0229339178__p41640866">Specifies the port ID of the NIC.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0229339178__li08034671018">Example request<pre class="screen" id="EN-US_TOPIC_0229339178__screen55305066202724">{
"nics": [
{
"id": "d32019d3-bc6e-4319-9c1d-6722fc136a23"
}
]
}</pre>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0229339178__section146911856165114"><h4 class="sectiontitle">Response</h4><ul id="EN-US_TOPIC_0229339178__ul1446320143814"><li id="EN-US_TOPIC_0229339178__li1146321411817">Response parameters</li></ul>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0229339178__table757167711151" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Normal response</caption><thead align="left"><tr id="EN-US_TOPIC_0229339178__row5251903911151"><th align="left" class="cellrowborder" valign="top" width="19.86%" id="mcps1.3.5.2.4.1.1"><p id="EN-US_TOPIC_0229339178__p2618376611151">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="23.669999999999998%" id="mcps1.3.5.2.4.1.2"><p id="EN-US_TOPIC_0229339178__p4051029311151">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="56.47%" id="mcps1.3.5.2.4.1.3"><p id="EN-US_TOPIC_0229339178__p6010832511151">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0229339178__row3693617411151"><td class="cellrowborder" valign="top" width="19.86%" headers="mcps1.3.5.2.4.1.1 "><p id="EN-US_TOPIC_0229339178__p3904008711151">job_id</p>
</td>
<td class="cellrowborder" valign="top" width="23.669999999999998%" headers="mcps1.3.5.2.4.1.2 "><p id="EN-US_TOPIC_0229339178__p813044011151">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.47%" headers="mcps1.3.5.2.4.1.3 "><p id="EN-US_TOPIC_0229339178__p193921820174211">Specifies the task ID returned after a task command is issued. The task ID can be used to query the execution status of the task.</p>
<p id="EN-US_TOPIC_0229339178__p5458589811151">For details about how to query the task execution status based on <strong id="EN-US_TOPIC_0229339178__b36922526215">job_id</strong>, see <a href="en-us_topic_0118696596.html">Querying Task Statuses</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0229339178__table6467239411151" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Abnormal response</caption><thead align="left"><tr id="EN-US_TOPIC_0229339178__row2581079811151"><th align="left" class="cellrowborder" valign="top" width="19.93%" id="mcps1.3.6.2.4.1.1"><p id="EN-US_TOPIC_0229339178__p1029990211151">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="23.69%" id="mcps1.3.6.2.4.1.2"><p id="EN-US_TOPIC_0229339178__p2898571411151">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="56.379999999999995%" id="mcps1.3.6.2.4.1.3"><p id="EN-US_TOPIC_0229339178__p6614149111151">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0229339178__row5586052011151"><td class="cellrowborder" valign="top" width="19.93%" headers="mcps1.3.6.2.4.1.1 "><p id="EN-US_TOPIC_0229339178__p2840824911151">error</p>
</td>
<td class="cellrowborder" valign="top" width="23.69%" headers="mcps1.3.6.2.4.1.2 "><p id="EN-US_TOPIC_0229339178__p1936686411151">Dictionary data structure</p>
</td>
<td class="cellrowborder" valign="top" width="56.379999999999995%" headers="mcps1.3.6.2.4.1.3 "><p id="EN-US_TOPIC_0229339178__p2558244011151">Specifies the error returned when a task submission encounters an exception. For details, see <a href="#EN-US_TOPIC_0229339178__table6409189311151">Table 5</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0229339178__table6409189311151"></a><a name="table6409189311151"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0229339178__table6409189311151" frame="border" border="1" rules="all"><caption><b>Table 5 </b><strong id="EN-US_TOPIC_0229339178__b4217161710018">error</strong> data structure</caption><thead align="left"><tr id="EN-US_TOPIC_0229339178__row2324327311151"><th align="left" class="cellrowborder" valign="top" width="20.169999999999998%" id="mcps1.3.7.2.4.1.1"><p id="EN-US_TOPIC_0229339178__p365693111151">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="23.369999999999997%" id="mcps1.3.7.2.4.1.2"><p id="EN-US_TOPIC_0229339178__p2777597711151">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="56.46%" id="mcps1.3.7.2.4.1.3"><p id="EN-US_TOPIC_0229339178__p3526170111151">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0229339178__row3762550011151"><td class="cellrowborder" valign="top" width="20.169999999999998%" headers="mcps1.3.7.2.4.1.1 "><p id="EN-US_TOPIC_0229339178__p2776668011151">message</p>
</td>
<td class="cellrowborder" valign="top" width="23.369999999999997%" headers="mcps1.3.7.2.4.1.2 "><p id="EN-US_TOPIC_0229339178__p3450864111151">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.46%" headers="mcps1.3.7.2.4.1.3 "><p id="EN-US_TOPIC_0229339178__p4373654211151">Specifies the error message.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0229339178__row5808456411151"><td class="cellrowborder" valign="top" width="20.169999999999998%" headers="mcps1.3.7.2.4.1.1 "><p id="EN-US_TOPIC_0229339178__p722924311151">code</p>
</td>
<td class="cellrowborder" valign="top" width="23.369999999999997%" headers="mcps1.3.7.2.4.1.2 "><p id="EN-US_TOPIC_0229339178__p4869780211151">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.46%" headers="mcps1.3.7.2.4.1.3 "><p id="EN-US_TOPIC_0229339178__p5220791411151">Specifies the error code.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="EN-US_TOPIC_0229339178__section19874359153411"><h4 class="sectiontitle">Example Response</h4><ul id="EN-US_TOPIC_0229339178__ul1934615883519"><li id="EN-US_TOPIC_0229339178__li834615803516">Normal response<div class="codecoloring" codetype="Java" id="EN-US_TOPIC_0229339178__screen3351794620424"><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></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;job_id&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;70a599e0-31e7-49b7-b260-868f441e862b&quot;</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_0229339178__section868814916514"><h4 class="sectiontitle">Returned Values</h4><div class="p" id="EN-US_TOPIC_0229339178__en-us_topic_0106040941_p193201622141412">Normal values
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0229339178__en-us_topic_0106040941_table753804619176" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0229339178__en-us_topic_0106040941_row10735134615172"><th align="left" class="cellrowborder" valign="top" width="42.42%" id="mcps1.3.9.2.1.1.3.1.1"><p id="EN-US_TOPIC_0229339178__en-us_topic_0106040941_p19735204616177">Returned Values</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="57.58%" id="mcps1.3.9.2.1.1.3.1.2"><p id="EN-US_TOPIC_0229339178__en-us_topic_0106040941_p207355465176">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0229339178__en-us_topic_0106040941_row1473514621713"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.9.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0229339178__en-us_topic_0106040941_p13735144611178">200</p>
</td>
<td class="cellrowborder" valign="top" width="57.58%" headers="mcps1.3.9.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0229339178__en-us_topic_0106040941_p207351246161711">The request has been successfully processed.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<p id="EN-US_TOPIC_0229339178__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_0229339178__section14752650154917"><h4 class="sectiontitle">Error Codes</h4><p id="EN-US_TOPIC_0229339178__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