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

134 lines
15 KiB
HTML
Raw Blame History

<a name="EN-US_TOPIC_0000002374101017"></a><a name="EN-US_TOPIC_0000002374101017"></a>
<h1 class="topictitle1">Restarting a <span id="en-us_topic_0053158716_text68606276113">BMS</span><span id="en-us_topic_0053158716_text1617819514128"></span><span id="en-us_topic_0053158716_text1180359203217"></span></h1>
<div id="body8662426"><div class="section" id="EN-US_TOPIC_0000002374101017__en-us_topic_0053158716_section6488958"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000002374101017__en-us_topic_0053158716_p64515557">This API is used to restart a single <span id="EN-US_TOPIC_0000002374101017__en-us_topic_0053158716_text5919181071216">BMS</span><span id="EN-US_TOPIC_0000002374101017__en-us_topic_0053158716_text1646417292112"></span><span id="EN-US_TOPIC_0000002374101017__en-us_topic_0053158716_text61753423314"></span>. </p>
</div>
<div class="section" id="EN-US_TOPIC_0000002374101017__en-us_topic_0053158716_section57278039123222"><h4 class="sectiontitle">Constraints</h4><p id="EN-US_TOPIC_0000002374101017__en-us_topic_0053158716_p223719591019">Currently, only forcible restart is supported.</p>
</div>
<div class="section" id="EN-US_TOPIC_0000002374101017__en-us_topic_0053158716_section58400626"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0000002374101017__en-us_topic_0053158716_p2504581615492">POST /v2.1/{project_id}/servers/{server_id}/action</p>
<p id="EN-US_TOPIC_0000002374101017__en-us_topic_0053158716_p0849111291"><a href="#EN-US_TOPIC_0000002374101017__en-us_topic_0053158716_table6943612162916">Table 1</a> lists the parameters.</p>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002374101017__en-us_topic_0053158716_table6943612162916"></a><a name="en-us_topic_0053158716_table6943612162916"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002374101017__en-us_topic_0053158716_table6943612162916" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0000002374101017__en-us_topic_0053158716_row1694351213299"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.3.4.2.4.1.1"><p id="EN-US_TOPIC_0000002374101017__en-us_topic_0053158716_p17522362913">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_0000002374101017__en-us_topic_0053158716_p5642312299">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_0000002374101017__en-us_topic_0053158716_p1391023202918">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002374101017__en-us_topic_0053158716_row5943201292911"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.3.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002374101017__en-us_topic_0053158716_p71132302912">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_0000002374101017__en-us_topic_0053158716_p91472372914">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_0000002374101017__en-us_topic_0053158716_p19165231293">Specifies the project ID.</p>
<p id="EN-US_TOPIC_0000002374101017__en-us_topic_0053158716_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_0000002374101017__en-us_topic_0053158716_row794311252918"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.3.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002374101017__en-us_topic_0053158716_p318162392918">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_0000002374101017__en-us_topic_0053158716_p1119162362913">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_0000002374101017__en-us_topic_0053158716_p192032314291">Specifies the <span id="EN-US_TOPIC_0000002374101017__en-us_topic_0053158716_text1891118159128">BMS</span><span id="EN-US_TOPIC_0000002374101017__en-us_topic_0053158716_text1591114152121"></span><span id="EN-US_TOPIC_0000002374101017__en-us_topic_0053158716_text9718181833314"></span> ID.</p>
<p id="EN-US_TOPIC_0000002374101017__en-us_topic_0053158716_p29791113277">You can obtain the BMS ID from the <span id="EN-US_TOPIC_0000002374101017__en-us_topic_0053158716_en-us_topic_0113746489_text895314101319">BMS</span><span id="EN-US_TOPIC_0000002374101017__en-us_topic_0053158716_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_0000002374101017__en-us_topic_0053158716_section55843593"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002374101017__en-us_topic_0053158716_table37818817" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0000002374101017__en-us_topic_0053158716_row57787318"><th align="left" class="cellrowborder" valign="top" width="16.64%" id="mcps1.3.4.2.1.5.1.1"><p id="EN-US_TOPIC_0000002374101017__en-us_topic_0053158716_p59978491115233">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.76%" id="mcps1.3.4.2.1.5.1.2"><p id="EN-US_TOPIC_0000002374101017__en-us_topic_0053158716_p25916685817">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="22.28%" id="mcps1.3.4.2.1.5.1.3"><p id="EN-US_TOPIC_0000002374101017__en-us_topic_0053158716_p26419641115233">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="43.32%" id="mcps1.3.4.2.1.5.1.4"><p id="EN-US_TOPIC_0000002374101017__en-us_topic_0053158716_p64181866115233">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002374101017__en-us_topic_0053158716_row13875810"><td class="cellrowborder" valign="top" width="16.64%" headers="mcps1.3.4.2.1.5.1.1 "><p id="EN-US_TOPIC_0000002374101017__en-us_topic_0053158716_p50198807">reboot</p>
</td>
<td class="cellrowborder" valign="top" width="17.76%" headers="mcps1.3.4.2.1.5.1.2 "><p id="EN-US_TOPIC_0000002374101017__en-us_topic_0053158716_p63270434181210">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="22.28%" headers="mcps1.3.4.2.1.5.1.3 "><p id="EN-US_TOPIC_0000002374101017__en-us_topic_0053158716_p51181499">Object</p>
</td>
<td class="cellrowborder" valign="top" width="43.32%" headers="mcps1.3.4.2.1.5.1.4 "><p id="EN-US_TOPIC_0000002374101017__en-us_topic_0053158716_p65893970">Specifies the operation of restarting the <span id="EN-US_TOPIC_0000002374101017__en-us_topic_0053158716_text202611519161218">BMS</span><span id="EN-US_TOPIC_0000002374101017__en-us_topic_0053158716_text126115192124"></span><span id="EN-US_TOPIC_0000002374101017__en-us_topic_0053158716_text16201927123315"></span>. For details, see <a href="#EN-US_TOPIC_0000002374101017__en-us_topic_0053158716_table10346346162744">Table 2</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002374101017__en-us_topic_0053158716_table10346346162744"></a><a name="en-us_topic_0053158716_table10346346162744"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002374101017__en-us_topic_0053158716_table10346346162744" frame="border" border="1" rules="all"><caption><b>Table 2 </b><strong id="EN-US_TOPIC_0000002374101017__en-us_topic_0053158716_b12176033237">reboot</strong> data structure</caption><thead align="left"><tr id="EN-US_TOPIC_0000002374101017__en-us_topic_0053158716_row45993853162744"><th align="left" class="cellrowborder" valign="top" width="18%" id="mcps1.3.4.3.2.5.1.1"><p id="EN-US_TOPIC_0000002374101017__en-us_topic_0053158716_p85714617589">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.68%" id="mcps1.3.4.3.2.5.1.2"><p id="EN-US_TOPIC_0000002374101017__en-us_topic_0053158716_p84832135211">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="21.95%" id="mcps1.3.4.3.2.5.1.3"><p id="EN-US_TOPIC_0000002374101017__en-us_topic_0053158716_p2049218166215">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="43.37%" id="mcps1.3.4.3.2.5.1.4"><p id="EN-US_TOPIC_0000002374101017__en-us_topic_0053158716_p5615615814">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002374101017__en-us_topic_0053158716_row41908639162744"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.4.3.2.5.1.1 "><p id="EN-US_TOPIC_0000002374101017__en-us_topic_0053158716_p39156593162744">type</p>
</td>
<td class="cellrowborder" valign="top" width="16.68%" headers="mcps1.3.4.3.2.5.1.2 "><p id="EN-US_TOPIC_0000002374101017__en-us_topic_0053158716_p164835131924">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="21.95%" headers="mcps1.3.4.3.2.5.1.3 "><p id="EN-US_TOPIC_0000002374101017__en-us_topic_0053158716_p144921162216">String</p>
</td>
<td class="cellrowborder" valign="top" width="43.37%" headers="mcps1.3.4.3.2.5.1.4 "><p id="EN-US_TOPIC_0000002374101017__en-us_topic_0053158716_p34131354162744">Specifies the type of the restart operation.</p>
<ul id="EN-US_TOPIC_0000002374101017__en-us_topic_0053158716_ul1169415154044"><li id="EN-US_TOPIC_0000002374101017__en-us_topic_0053158716_li14099013154044"><strong id="EN-US_TOPIC_0000002374101017__en-us_topic_0053158716_b446993617346">SOFT</strong>: soft restart</li><li id="EN-US_TOPIC_0000002374101017__en-us_topic_0053158716_li46022347151024"><strong id="EN-US_TOPIC_0000002374101017__en-us_topic_0053158716_b12469236123417">HARD</strong>: forcible restart<div class="note" id="EN-US_TOPIC_0000002374101017__en-us_topic_0053158716_note3080306151059"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="EN-US_TOPIC_0000002374101017__en-us_topic_0053158716_p27722756151059">Currently, value <strong id="EN-US_TOPIC_0000002374101017__en-us_topic_0053158716_b842352706161220">SOFT</strong> is invalid. All BMS restart operations are forcible restart.</p>
</div></div>
</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000002374101017__en-us_topic_0053158716_section10521172814337"><h4 class="sectiontitle">Example Request</h4><div class="p" id="EN-US_TOPIC_0000002374101017__en-us_topic_0053158716_p12773141284920">Restarting a <span id="EN-US_TOPIC_0000002374101017__en-us_topic_0053158716_text266731472811">BMS</span><span id="EN-US_TOPIC_0000002374101017__en-us_topic_0053158716_text7802430369"></span><span id="EN-US_TOPIC_0000002374101017__en-us_topic_0053158716_text549771912419"></span> (ID: 95bf2490-5428-432c-ad9b-5e3406f869dd)<div class="codecoloring" codetype="Java" id="EN-US_TOPIC_0000002374101017__en-us_topic_0053158716_screen994625113359"><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_0000002374101017__en-us_topic_0053158716_screen52812733194534"><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></pre></div></td><td class="code"><div><pre><span></span><span class="p">{</span>
<span class="w"> </span><span class="s">&quot;reboot&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="s">&quot;type&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;HARD&quot;</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_0000002374101017__en-us_topic_0053158716_section32830290"><h4 class="sectiontitle">Response</h4><p id="EN-US_TOPIC_0000002374101017__en-us_topic_0053158716_p29397739">N/A</p>
</div>
<div class="section" id="EN-US_TOPIC_0000002374101017__en-us_topic_0053158716_section27037160"><h4 class="sectiontitle">Returned Values</h4><div class="p" id="EN-US_TOPIC_0000002374101017__en-us_topic_0053158716_en-us_topic_0053158659_p1271142611013">Normal values
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002374101017__en-us_topic_0053158716_en-us_topic_0053158659_table753804619176" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0000002374101017__en-us_topic_0053158716_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_0000002374101017__en-us_topic_0053158716_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_0000002374101017__en-us_topic_0053158716_en-us_topic_0053158659_p207355465176">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002374101017__en-us_topic_0053158716_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_0000002374101017__en-us_topic_0053158716_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_0000002374101017__en-us_topic_0053158716_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_0000002374101017__en-us_topic_0053158716_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_0000002374101017__en-us_topic_0053158716_section14752650154917"><h4 class="sectiontitle">Error Codes</h4><p id="EN-US_TOPIC_0000002374101017__en-us_topic_0053158716_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