forked from docs/doc-exports
guoyanyan
78c80b1b46
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com> Co-authored-by: guoyanyan <guoyanyan3@huawei.com> Co-committed-by: guoyanyan <guoyanyan3@huawei.com>
136 lines
12 KiB
HTML
136 lines
12 KiB
HTML
<a name="EN-US_TOPIC_0053158716"></a><a name="EN-US_TOPIC_0053158716"></a>
|
|
|
|
<h1 class="topictitle1">Restarting a <span id="text68606276113">BMS</span><span id="text1617819514128"></span> (Native OpenStack API)</h1>
|
|
<div id="body47192740"><div class="section" id="EN-US_TOPIC_0053158716__section6488958"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0053158716__p64515557">This API is used to restart a single <span id="EN-US_TOPIC_0053158716__text5919181071216">BMS</span><span id="EN-US_TOPIC_0053158716__text1646417292112"></span>. </p>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0053158716__section57278039123222"><h4 class="sectiontitle">Constraints</h4><p id="EN-US_TOPIC_0053158716__p223719591019">Currently, only forcible restart is supported.</p>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0053158716__section58400626"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0053158716__p2504581615492">POST /v2.1/{project_id}/servers/{server_id}/action</p>
|
|
<p id="EN-US_TOPIC_0053158716__p0849111291"><a href="#EN-US_TOPIC_0053158716__table6943612162916">Table 1</a> lists the parameters.</p>
|
|
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0053158716__table6943612162916"></a><a name="table6943612162916"></a><table cellpadding="4" cellspacing="0" summary="" id="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_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_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_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_0053158716__p1391023202918">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="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_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_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_0053158716__p19165231293">Specifies the project ID.</p>
|
|
<p id="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_0053158716__row794311252918"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.3.4.2.4.1.1 "><p id="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_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_0053158716__p192032314291">Specifies the <span id="EN-US_TOPIC_0053158716__text1891118159128">BMS</span><span id="EN-US_TOPIC_0053158716__text1591114152121"></span> ID.</p>
|
|
<p id="EN-US_TOPIC_0053158716__p29791113277">You can obtain the BMS ID from the <span id="EN-US_TOPIC_0053158716__en-us_topic_0113746489_text013014803615">BMS</span><span id="EN-US_TOPIC_0053158716__en-us_topic_0113746489_text10131448133612"></span> console or using the <a href="en-us_topic_0053158693.html">Querying BMSs (Native OpenStack API)</a> API.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0053158716__section55843593"><h4 class="sectiontitle">Request</h4><ul id="EN-US_TOPIC_0053158716__ul39699339"><li id="EN-US_TOPIC_0053158716__li26571712">Request parameters
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0053158716__table37818817" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0053158716__row57787318"><th align="left" class="cellrowborder" valign="top" width="16.64%" id="mcps1.3.4.2.1.1.1.5.1.1"><p id="EN-US_TOPIC_0053158716__p59978491115233">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17.76%" id="mcps1.3.4.2.1.1.1.5.1.2"><p id="EN-US_TOPIC_0053158716__p25916685817">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="22.28%" id="mcps1.3.4.2.1.1.1.5.1.3"><p id="EN-US_TOPIC_0053158716__p26419641115233">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="43.32%" id="mcps1.3.4.2.1.1.1.5.1.4"><p id="EN-US_TOPIC_0053158716__p64181866115233">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0053158716__row13875810"><td class="cellrowborder" valign="top" width="16.64%" headers="mcps1.3.4.2.1.1.1.5.1.1 "><p id="EN-US_TOPIC_0053158716__p50198807">reboot</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.76%" headers="mcps1.3.4.2.1.1.1.5.1.2 "><p id="EN-US_TOPIC_0053158716__p63270434181210">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.28%" headers="mcps1.3.4.2.1.1.1.5.1.3 "><p id="EN-US_TOPIC_0053158716__p51181499">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="43.32%" headers="mcps1.3.4.2.1.1.1.5.1.4 "><p id="EN-US_TOPIC_0053158716__p65893970">Specifies the operation of restarting the <span id="EN-US_TOPIC_0053158716__text202611519161218">BMS</span><span id="EN-US_TOPIC_0053158716__text126115192124"></span>. For details, see <a href="#EN-US_TOPIC_0053158716__table10346346162744">Table 2</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0053158716__table10346346162744"></a><a name="table10346346162744"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0053158716__table10346346162744" frame="border" border="1" rules="all"><caption><b>Table 2 </b><strong id="EN-US_TOPIC_0053158716__b16774838163714">reboot</strong> field data structure description</caption><thead align="left"><tr id="EN-US_TOPIC_0053158716__row45993853162744"><th align="left" class="cellrowborder" valign="top" width="18%" id="mcps1.3.4.2.1.2.2.5.1.1"><p id="EN-US_TOPIC_0053158716__p85714617589">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16.68%" id="mcps1.3.4.2.1.2.2.5.1.2"><p id="EN-US_TOPIC_0053158716__p84832135211">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="21.95%" id="mcps1.3.4.2.1.2.2.5.1.3"><p id="EN-US_TOPIC_0053158716__p2049218166215">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="43.37%" id="mcps1.3.4.2.1.2.2.5.1.4"><p id="EN-US_TOPIC_0053158716__p5615615814">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0053158716__row41908639162744"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.4.2.1.2.2.5.1.1 "><p id="EN-US_TOPIC_0053158716__p39156593162744">type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.68%" headers="mcps1.3.4.2.1.2.2.5.1.2 "><p id="EN-US_TOPIC_0053158716__p164835131924">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.95%" headers="mcps1.3.4.2.1.2.2.5.1.3 "><p id="EN-US_TOPIC_0053158716__p144921162216">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="43.37%" headers="mcps1.3.4.2.1.2.2.5.1.4 "><p id="EN-US_TOPIC_0053158716__p34131354162744">Specifies the type of the restart operation.</p>
|
|
<ul id="EN-US_TOPIC_0053158716__ul1169415154044"><li id="EN-US_TOPIC_0053158716__li14099013154044"><strong>SOFT</strong>: soft restart</li><li id="EN-US_TOPIC_0053158716__li46022347151024"><strong>HARD</strong>: forcible restart<div class="note" id="EN-US_TOPIC_0053158716__note3080306151059"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="EN-US_TOPIC_0053158716__p27722756151059">Currently, value <strong id="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>
|
|
</li></ul>
|
|
<ul id="EN-US_TOPIC_0053158716__ul25944301162751"><li id="EN-US_TOPIC_0053158716__li57580256103230">Example request<div class="codecoloring" codetype="Java" id="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><span class="w"></span>
|
|
</pre></div></td></tr></table></div>
|
|
|
|
</div>
|
|
<div class="codecoloring" codetype="Java" id="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="w"> </span><span class="s">"reboot"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w"></span>
|
|
<span class="w"> </span><span class="s">"type"</span><span class="p">:</span><span class="w"> </span><span class="s">"HARD"</span><span class="w"></span>
|
|
<span class="w"> </span><span class="p">}</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_0053158716__section32830290"><h4 class="sectiontitle">Response</h4><p id="EN-US_TOPIC_0053158716__p29397739">N/A</p>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0053158716__section27037160"><h4 class="sectiontitle">Returned Values</h4><div class="p" id="EN-US_TOPIC_0053158716__en-us_topic_0053158659_p1271142611013">Normal values
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0053158716__en-us_topic_0053158659_table753804619176" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0053158716__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_0053158716__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_0053158716__en-us_topic_0053158659_p207355465176">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0053158716__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_0053158716__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_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_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_0053158716__section14752650154917"><h4 class="sectiontitle">Error Codes</h4><p id="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_0053158613.html">BMS Status Management</a></div>
|
|
</div>
|
|
</div>
|
|
|