yexinru/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
Files
a41a4e0331fbc0beff63bb28fa59228cc9a751df
doc-exports/docs/bms/api-ref/en-us_topic_0000002374260881.html
wanghuijuan738 69783f9e3e bms api 20241225 version 
Reviewed-by: Pristromskaia, Margarita <margarita.pristromskaia@t-systems.com>
Co-authored-by: wanghuijuan738 <wanghuijuan738@huawei.com>
Co-committed-by: wanghuijuan738 <wanghuijuan738@huawei.com>
2025-07-16 09:58:55 +00:00

131 lines
16 KiB
HTML
Raw Blame History

<a name="EN-US_TOPIC_0000002374260881"></a><a name="EN-US_TOPIC_0000002374260881"></a>
<h1 class="topictitle1">Stopping a <span id="en-us_topic_0053158685_text68606276113">BMS</span><span id="en-us_topic_0053158685_text22941634181516"></span><span id="en-us_topic_0053158685_text12978185110334"></span></h1>
<div id="body8662426"><div class="section" id="EN-US_TOPIC_0000002374260881__en-us_topic_0053158685_section32841145"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000002374260881__en-us_topic_0053158685_p35717517">This API is used to stop a single <span id="EN-US_TOPIC_0000002374260881__en-us_topic_0053158685_text1056704081515">BMS</span><span id="EN-US_TOPIC_0000002374260881__en-us_topic_0053158685_text956764016151"></span><span id="EN-US_TOPIC_0000002374260881__en-us_topic_0053158685_text931214253311"></span>. </p>
<p id="EN-US_TOPIC_0000002374260881__en-us_topic_0053158685_p15736125710549">This API has been deprecated. Use the API in <a href="en-us_topic_0131356393.html">Stopping BMSs</a>.</p>
</div>
<div class="section" id="EN-US_TOPIC_0000002374260881__en-us_topic_0053158685_section57278039123222"><h4 class="sectiontitle">Constraints</h4><ul id="EN-US_TOPIC_0000002374260881__en-us_topic_0053158685_ul36349652182222"><li id="EN-US_TOPIC_0000002374260881__en-us_topic_0053158685_li2347440182222">The <strong id="EN-US_TOPIC_0000002374260881__en-us_topic_0053158685_b20493711202916">OS-EXT-STS:vm_state</strong> attribute (<span id="EN-US_TOPIC_0000002374260881__en-us_topic_0053158685_text2097334201514">BMS</span><span id="EN-US_TOPIC_0000002374260881__en-us_topic_0053158685_text197314241518"></span><span id="EN-US_TOPIC_0000002374260881__en-us_topic_0053158685_text3267146153312"></span> status) must be <strong id="EN-US_TOPIC_0000002374260881__en-us_topic_0053158685_b20996722132910">active</strong> or <strong id="EN-US_TOPIC_0000002374260881__en-us_topic_0053158685_b152041726152918">error</strong>.</li><li id="EN-US_TOPIC_0000002374260881__en-us_topic_0053158685_li4194388512207">Currently, only forcible stopping is supported.</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0000002374260881__en-us_topic_0053158685_section27134857"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0000002374260881__en-us_topic_0053158685_p24317152155315">POST /v2.1/{project_id}/servers/{server_id}/action</p>
<p id="EN-US_TOPIC_0000002374260881__en-us_topic_0053158685_p18365358173020"><a href="#EN-US_TOPIC_0000002374260881__en-us_topic_0053158685_table1997078319">Table 1</a> lists the parameters.</p>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002374260881__en-us_topic_0053158685_table1997078319"></a><a name="en-us_topic_0053158685_table1997078319"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002374260881__en-us_topic_0053158685_table1997078319" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0000002374260881__en-us_topic_0053158685_row1697157163111"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.3.4.2.4.1.1"><p id="EN-US_TOPIC_0000002374260881__en-us_topic_0053158685_p61356140">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.3.4.2.4.1.2"><p id="EN-US_TOPIC_0000002374260881__en-us_topic_0053158685_p3791404">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.3.4.2.4.1.3"><p id="EN-US_TOPIC_0000002374260881__en-us_topic_0053158685_p38668280">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002374260881__en-us_topic_0053158685_row1973711316"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.3.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002374260881__en-us_topic_0053158685_p31084503">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.3.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002374260881__en-us_topic_0053158685_p34816825">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.3.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002374260881__en-us_topic_0053158685_p1590600">Specifies the project ID.</p>
<p id="EN-US_TOPIC_0000002374260881__en-us_topic_0053158685_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_0000002374260881__en-us_topic_0053158685_row39716712314"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.3.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002374260881__en-us_topic_0053158685_p18697032">server_id</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.3.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002374260881__en-us_topic_0053158685_p38064613">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.3.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002374260881__en-us_topic_0053158685_p63334794">Specifies the <span id="EN-US_TOPIC_0000002374260881__en-us_topic_0053158685_text959384631516">BMS</span><span id="EN-US_TOPIC_0000002374260881__en-us_topic_0053158685_text1359394651514"></span><span id="EN-US_TOPIC_0000002374260881__en-us_topic_0053158685_text422914123420"></span> ID.</p>
<p id="EN-US_TOPIC_0000002374260881__en-us_topic_0053158685_p29791113277">You can obtain the BMS ID from the <span id="EN-US_TOPIC_0000002374260881__en-us_topic_0053158685_en-us_topic_0113746489_text895314101319">BMS</span><span id="EN-US_TOPIC_0000002374260881__en-us_topic_0053158685_en-us_topic_0113746489_text1695320481317"></span> console or by calling the API <a href="en-us_topic_0000002340063012.html">Querying BMSs</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000002374260881__en-us_topic_0053158685_section42887128"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002374260881__en-us_topic_0053158685_table54550461" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0000002374260881__en-us_topic_0053158685_row11842506"><th align="left" class="cellrowborder" valign="top" width="19.040000000000003%" id="mcps1.3.4.2.1.5.1.1"><p id="EN-US_TOPIC_0000002374260881__en-us_topic_0053158685_p59978491115233">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.21%" id="mcps1.3.4.2.1.5.1.2"><p id="EN-US_TOPIC_0000002374260881__en-us_topic_0053158685_p183901830522">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="22.61%" id="mcps1.3.4.2.1.5.1.3"><p id="EN-US_TOPIC_0000002374260881__en-us_topic_0053158685_p26419641115233">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="42.14%" id="mcps1.3.4.2.1.5.1.4"><p id="EN-US_TOPIC_0000002374260881__en-us_topic_0053158685_p64181866115233">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002374260881__en-us_topic_0053158685_row48896832"><td class="cellrowborder" valign="top" width="19.040000000000003%" headers="mcps1.3.4.2.1.5.1.1 "><p id="EN-US_TOPIC_0000002374260881__en-us_topic_0053158685_p1220438">os-stop</p>
</td>
<td class="cellrowborder" valign="top" width="16.21%" headers="mcps1.3.4.2.1.5.1.2 "><p id="EN-US_TOPIC_0000002374260881__en-us_topic_0053158685_p0389123016219">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="22.61%" headers="mcps1.3.4.2.1.5.1.3 "><p id="EN-US_TOPIC_0000002374260881__en-us_topic_0053158685_p21345065">Object</p>
</td>
<td class="cellrowborder" valign="top" width="42.14%" headers="mcps1.3.4.2.1.5.1.4 "><p id="EN-US_TOPIC_0000002374260881__en-us_topic_0053158685_p58405349">Specifies the operation of stopping the <span id="EN-US_TOPIC_0000002374260881__en-us_topic_0053158685_text16893205917151">BMS</span><span id="EN-US_TOPIC_0000002374260881__en-us_topic_0053158685_text589315921515"></span><span id="EN-US_TOPIC_0000002374260881__en-us_topic_0053158685_text650420149344"></span>. For details, see <a href="#EN-US_TOPIC_0000002374260881__en-us_topic_0053158685_table10346346162744">Table 2</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002374260881__en-us_topic_0053158685_table10346346162744"></a><a name="en-us_topic_0053158685_table10346346162744"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002374260881__en-us_topic_0053158685_table10346346162744" frame="border" border="1" rules="all"><caption><b>Table 2 </b><strong id="EN-US_TOPIC_0000002374260881__en-us_topic_0053158685_b5951437836">os-stop</strong> data structure</caption><thead align="left"><tr id="EN-US_TOPIC_0000002374260881__en-us_topic_0053158685_row45993853162744"><th align="left" class="cellrowborder" valign="top" width="19.11%" id="mcps1.3.4.3.2.5.1.1"><p id="EN-US_TOPIC_0000002374260881__en-us_topic_0053158685_p15821544165817">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.669999999999998%" id="mcps1.3.4.3.2.5.1.2"><p id="EN-US_TOPIC_0000002374260881__en-us_topic_0053158685_p16821737324">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="24.44%" id="mcps1.3.4.3.2.5.1.3"><p id="EN-US_TOPIC_0000002374260881__en-us_topic_0053158685_p105851844185813">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="39.78%" id="mcps1.3.4.3.2.5.1.4"><p id="EN-US_TOPIC_0000002374260881__en-us_topic_0053158685_p858711445580">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002374260881__en-us_topic_0053158685_row41908639162744"><td class="cellrowborder" valign="top" width="19.11%" headers="mcps1.3.4.3.2.5.1.1 "><p id="EN-US_TOPIC_0000002374260881__en-us_topic_0053158685_p39156593162744">type</p>
</td>
<td class="cellrowborder" valign="top" width="16.669999999999998%" headers="mcps1.3.4.3.2.5.1.2 "><p id="EN-US_TOPIC_0000002374260881__en-us_topic_0053158685_p76815371823">No</p>
</td>
<td class="cellrowborder" valign="top" width="24.44%" headers="mcps1.3.4.3.2.5.1.3 "><p id="EN-US_TOPIC_0000002374260881__en-us_topic_0053158685_p13677446162744">String</p>
</td>
<td class="cellrowborder" valign="top" width="39.78%" headers="mcps1.3.4.3.2.5.1.4 "><p id="EN-US_TOPIC_0000002374260881__en-us_topic_0053158685_p34131354162744">Specifies the type of the BMS stopping operation.</p>
<ul id="EN-US_TOPIC_0000002374260881__en-us_topic_0053158685_ul1169415154044"><li id="EN-US_TOPIC_0000002374260881__en-us_topic_0053158685_li14099013154044"><strong id="EN-US_TOPIC_0000002374260881__en-us_topic_0053158685_b504423009171038">SOFT</strong>: normal BMS stopping</li><li id="EN-US_TOPIC_0000002374260881__en-us_topic_0053158685_li59782258154044"><strong id="EN-US_TOPIC_0000002374260881__en-us_topic_0053158685_b8423527061788">HARD</strong>: Forcible BMS stopping<div class="note" id="EN-US_TOPIC_0000002374260881__en-us_topic_0053158685_note3080306151059"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="EN-US_TOPIC_0000002374260881__en-us_topic_0053158685_p27722756151059">Currently, this parameter is invalid. All BMS stopping operations are forcible stopping.</p>
</div></div>
</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000002374260881__en-us_topic_0053158685_section173861952193317"><h4 class="sectiontitle">Example Request</h4><div class="p" id="EN-US_TOPIC_0000002374260881__en-us_topic_0053158685_p1633515490497">Stopping a <span id="EN-US_TOPIC_0000002374260881__en-us_topic_0053158685_text74812735116">BMS</span><span id="EN-US_TOPIC_0000002374260881__en-us_topic_0053158685_text148372516"></span><span id="EN-US_TOPIC_0000002374260881__en-us_topic_0053158685_text164815711514"></span> (ID: 95bf2490-5428-432c-ad9b-5e3406f869dd)<div class="codecoloring" codetype="Java" id="EN-US_TOPIC_0000002374260881__en-us_topic_0053158685_screen141311718183618"><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">POST</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/action</span>
</pre></div></td></tr></table></div>
</div>
<div class="codecoloring" codetype="Java" id="EN-US_TOPIC_0000002374260881__en-us_topic_0053158685_screen64712762194611"><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="s">&quot;os-stop&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{}</span>
<span class="p">}</span>
</pre></div></td></tr></table></div>
</div>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000002374260881__en-us_topic_0053158685_section50439840"><h4 class="sectiontitle">Response</h4><p id="EN-US_TOPIC_0000002374260881__en-us_topic_0053158685_p33212803">N/A</p>
</div>
<div class="section" id="EN-US_TOPIC_0000002374260881__en-us_topic_0053158685_section27037160"><h4 class="sectiontitle">Returned Values</h4><div class="p" id="EN-US_TOPIC_0000002374260881__en-us_topic_0053158685_en-us_topic_0053158659_p1271142611013">Normal values
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002374260881__en-us_topic_0053158685_en-us_topic_0053158659_table753804619176" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0000002374260881__en-us_topic_0053158685_en-us_topic_0053158659_row10735134615172"><th align="left" class="cellrowborder" valign="top" width="42.42%" id="mcps1.3.7.2.1.1.3.1.1"><p id="EN-US_TOPIC_0000002374260881__en-us_topic_0053158685_en-us_topic_0053158659_p19735204616177">Returned Values</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="57.58%" id="mcps1.3.7.2.1.1.3.1.2"><p id="EN-US_TOPIC_0000002374260881__en-us_topic_0053158685_en-us_topic_0053158659_p207355465176">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002374260881__en-us_topic_0053158685_en-us_topic_0053158659_row1473514621713"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.7.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0000002374260881__en-us_topic_0053158685_en-us_topic_0053158659_p13735144611178">204</p>
</td>
<td class="cellrowborder" valign="top" width="57.58%" headers="mcps1.3.7.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0000002374260881__en-us_topic_0053158685_en-us_topic_0053158659_p81516575011">The server has processed the request but did not return any content.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<p id="EN-US_TOPIC_0000002374260881__en-us_topic_0053158685_en-us_topic_0053158659_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_0000002374260881__en-us_topic_0053158685_section14752650154917"><h4 class="sectiontitle">Error Codes</h4><p id="EN-US_TOPIC_0000002374260881__en-us_topic_0053158685_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_0000002374260869.html">BMS Status Management (OpenStack Nova APIs)</a></div>
</div>
</div>
View Git Blame Copy Permalink