forked from docs/doc-exports
guoyanyan
c311ecafe3
Reviewed-by: Pristromskaia, Margarita <margarita.pristromskaia@t-systems.com> Co-authored-by: guoyanyan <guoyanyan3@huawei.com> Co-committed-by: guoyanyan <guoyanyan3@huawei.com>
132 lines
12 KiB
HTML
132 lines
12 KiB
HTML
<a name="EN-US_TOPIC_0053158685"></a><a name="EN-US_TOPIC_0053158685"></a>
|
|
|
|
<h1 class="topictitle1">Stopping a <span id="text68606276113">BMS</span><span id="text22941634181516"></span><span id="text12978185110334"></span> (Native OpenStack API)</h1>
|
|
<div id="body21982073"><div class="section" id="EN-US_TOPIC_0053158685__section32841145"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0053158685__p35717517">This API is used to stop a single <span id="EN-US_TOPIC_0053158685__text1056704081515">BMS</span><span id="EN-US_TOPIC_0053158685__text956764016151"></span><span id="EN-US_TOPIC_0053158685__text931214253311"></span>. </p>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0053158685__section57278039123222"><h4 class="sectiontitle">Constraints</h4><ul id="EN-US_TOPIC_0053158685__ul36349652182222"><li id="EN-US_TOPIC_0053158685__li2347440182222">The <strong id="EN-US_TOPIC_0053158685__b20493711202916">OS-EXT-STS:vm_state</strong> attribute (<span id="EN-US_TOPIC_0053158685__text2097334201514">BMS</span><span id="EN-US_TOPIC_0053158685__text197314241518"></span><span id="EN-US_TOPIC_0053158685__text3267146153312"></span> status) must be <strong id="EN-US_TOPIC_0053158685__b20996722132910">active</strong> or <strong id="EN-US_TOPIC_0053158685__b152041726152918">error</strong>.</li><li id="EN-US_TOPIC_0053158685__li4194388512207">Currently, only forcible stopping is supported.</li></ul>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0053158685__section27134857"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0053158685__p24317152155315">POST /v2.1/{project_id}/servers/{server_id}/action</p>
|
|
<p id="EN-US_TOPIC_0053158685__p18365358173020"><a href="#EN-US_TOPIC_0053158685__table1997078319">Table 1</a> lists the parameters.</p>
|
|
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0053158685__table1997078319"></a><a name="table1997078319"></a><table cellpadding="4" cellspacing="0" summary="" id="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_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_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_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_0053158685__p38668280">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="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_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_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_0053158685__p1590600">Specifies the project ID.</p>
|
|
<p id="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_0053158685__row39716712314"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.3.4.2.4.1.1 "><p id="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_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_0053158685__p63334794">Specifies the <span id="EN-US_TOPIC_0053158685__text959384631516">BMS</span><span id="EN-US_TOPIC_0053158685__text1359394651514"></span><span id="EN-US_TOPIC_0053158685__text422914123420"></span> ID.</p>
|
|
<p id="EN-US_TOPIC_0053158685__p29791113277">You can obtain the BMS ID from the <span id="EN-US_TOPIC_0053158685__en-us_topic_0113746489_text013014803615">BMS</span><span id="EN-US_TOPIC_0053158685__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 class="section" id="EN-US_TOPIC_0053158685__section42887128"><h4 class="sectiontitle">Request</h4><ul id="EN-US_TOPIC_0053158685__ul29844704"><li id="EN-US_TOPIC_0053158685__li13517702">Request parameters
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0053158685__table54550461" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0053158685__row11842506"><th align="left" class="cellrowborder" valign="top" width="19.040000000000003%" id="mcps1.3.4.2.1.1.1.5.1.1"><p id="EN-US_TOPIC_0053158685__p59978491115233">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16.21%" id="mcps1.3.4.2.1.1.1.5.1.2"><p id="EN-US_TOPIC_0053158685__p183901830522">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="22.61%" id="mcps1.3.4.2.1.1.1.5.1.3"><p id="EN-US_TOPIC_0053158685__p26419641115233">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="42.14%" id="mcps1.3.4.2.1.1.1.5.1.4"><p id="EN-US_TOPIC_0053158685__p64181866115233">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0053158685__row48896832"><td class="cellrowborder" valign="top" width="19.040000000000003%" headers="mcps1.3.4.2.1.1.1.5.1.1 "><p id="EN-US_TOPIC_0053158685__p1220438">os-stop</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.21%" headers="mcps1.3.4.2.1.1.1.5.1.2 "><p id="EN-US_TOPIC_0053158685__p0389123016219">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.61%" headers="mcps1.3.4.2.1.1.1.5.1.3 "><p id="EN-US_TOPIC_0053158685__p21345065">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="42.14%" headers="mcps1.3.4.2.1.1.1.5.1.4 "><p id="EN-US_TOPIC_0053158685__p58405349">Specifies the operation of stopping the <span id="EN-US_TOPIC_0053158685__text16893205917151">BMS</span><span id="EN-US_TOPIC_0053158685__text589315921515"></span><span id="EN-US_TOPIC_0053158685__text650420149344"></span>. For details, see <a href="#EN-US_TOPIC_0053158685__table10346346162744">Table 2</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0053158685__table10346346162744"></a><a name="table10346346162744"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0053158685__table10346346162744" frame="border" border="1" rules="all"><caption><b>Table 2 </b><strong id="EN-US_TOPIC_0053158685__b1419915303423">os-stop</strong> field data structure description</caption><thead align="left"><tr id="EN-US_TOPIC_0053158685__row45993853162744"><th align="left" class="cellrowborder" valign="top" width="19.11%" id="mcps1.3.4.2.1.2.2.5.1.1"><p id="EN-US_TOPIC_0053158685__p15821544165817">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16.669999999999998%" id="mcps1.3.4.2.1.2.2.5.1.2"><p id="EN-US_TOPIC_0053158685__p16821737324">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="24.44%" id="mcps1.3.4.2.1.2.2.5.1.3"><p id="EN-US_TOPIC_0053158685__p105851844185813">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="39.78%" id="mcps1.3.4.2.1.2.2.5.1.4"><p id="EN-US_TOPIC_0053158685__p858711445580">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0053158685__row41908639162744"><td class="cellrowborder" valign="top" width="19.11%" headers="mcps1.3.4.2.1.2.2.5.1.1 "><p id="EN-US_TOPIC_0053158685__p39156593162744">type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.669999999999998%" headers="mcps1.3.4.2.1.2.2.5.1.2 "><p id="EN-US_TOPIC_0053158685__p76815371823">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="24.44%" headers="mcps1.3.4.2.1.2.2.5.1.3 "><p id="EN-US_TOPIC_0053158685__p13677446162744">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.78%" headers="mcps1.3.4.2.1.2.2.5.1.4 "><p id="EN-US_TOPIC_0053158685__p34131354162744">Specifies the type of the BMS stopping operation.</p>
|
|
<ul id="EN-US_TOPIC_0053158685__ul1169415154044"><li id="EN-US_TOPIC_0053158685__li14099013154044"><strong id="EN-US_TOPIC_0053158685__b504423009171038">SOFT</strong>: normal BMS stopping</li><li id="EN-US_TOPIC_0053158685__li59782258154044"><strong id="EN-US_TOPIC_0053158685__b8423527061788">HARD</strong>: Forcible BMS stopping<div class="note" id="EN-US_TOPIC_0053158685__note3080306151059"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="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>
|
|
</li></ul>
|
|
<ul id="EN-US_TOPIC_0053158685__ul6550390114326"><li id="EN-US_TOPIC_0053158685__li40571673103253">Example request<div class="codecoloring" codetype="Java" id="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_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">"os-stop"</span><span class="p">:</span><span class="w"> </span><span class="p">{}</span>
|
|
<span class="p">}</span>
|
|
</pre></div></td></tr></table></div>
|
|
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0053158685__section50439840"><h4 class="sectiontitle">Response</h4><p id="EN-US_TOPIC_0053158685__p33212803">N/A</p>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0053158685__section27037160"><h4 class="sectiontitle">Returned Values</h4><div class="p" id="EN-US_TOPIC_0053158685__en-us_topic_0053158659_p1271142611013">Normal values
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0053158685__en-us_topic_0053158659_table753804619176" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0053158685__en-us_topic_0053158659_row10735134615172"><th align="left" class="cellrowborder" valign="top" width="42.42%" id="mcps1.3.6.2.1.1.3.1.1"><p id="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.6.2.1.1.3.1.2"><p id="EN-US_TOPIC_0053158685__en-us_topic_0053158659_p207355465176">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0053158685__en-us_topic_0053158659_row1473514621713"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.6.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0053158685__en-us_topic_0053158659_p13735144611178">204</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.58%" headers="mcps1.3.6.2.1.1.3.1.2 "><p id="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_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_0053158685__section14752650154917"><h4 class="sectiontitle">Error Codes</h4><p id="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_0053158613.html">BMS Status Management</a></div>
|
|
</div>
|
|
</div>
|
|
|