Files
doc-exports/docs/bms/api-ref/en-us_topic_0000002340063016.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

102 lines
11 KiB
HTML

<a name="EN-US_TOPIC_0000002340063016"></a><a name="EN-US_TOPIC_0000002340063016"></a>
<h1 class="topictitle1">Starting a <span id="en-us_topic_0053158659_text68606276113">BMS</span><span id="en-us_topic_0053158659_text1646417292112"></span><span id="en-us_topic_0053158659_text99571026173215"></span></h1>
<div id="body8662426"><div class="section" id="EN-US_TOPIC_0000002340063016__en-us_topic_0053158659_section5894231"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000002340063016__en-us_topic_0053158659_p15537542">This API is used to start a single <span id="EN-US_TOPIC_0000002340063016__en-us_topic_0053158659_text1638394119">BMS</span><span id="EN-US_TOPIC_0000002340063016__en-us_topic_0053158659_text03539161113"></span><span id="EN-US_TOPIC_0000002340063016__en-us_topic_0053158659_text10922143213327"></span>. </p>
</div>
<div class="section" id="EN-US_TOPIC_0000002340063016__en-us_topic_0053158659_section53048087"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0000002340063016__en-us_topic_0053158659_p1662293154346">POST /v2.1/{project_id}/servers/{server_id}/action</p>
<p id="EN-US_TOPIC_0000002340063016__en-us_topic_0053158659_p20251173712013"><a href="#EN-US_TOPIC_0000002340063016__en-us_topic_0053158659_table15103162717019">Table 1</a> lists the parameters.</p>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002340063016__en-us_topic_0053158659_table15103162717019"></a><a name="en-us_topic_0053158659_table15103162717019"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002340063016__en-us_topic_0053158659_table15103162717019" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0000002340063016__en-us_topic_0053158659_row6103127604"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.2.4.2.4.1.1"><p id="EN-US_TOPIC_0000002340063016__en-us_topic_0053158659_p53294272">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.2.4.2.4.1.2"><p id="EN-US_TOPIC_0000002340063016__en-us_topic_0053158659_p21868813">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.2.4.2.4.1.3"><p id="EN-US_TOPIC_0000002340063016__en-us_topic_0053158659_p26543418">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002340063016__en-us_topic_0053158659_row201031271407"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002340063016__en-us_topic_0053158659_p3865173">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002340063016__en-us_topic_0053158659_p44643603">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002340063016__en-us_topic_0053158659_p59362130">Specifies the project ID.</p>
<p id="EN-US_TOPIC_0000002340063016__en-us_topic_0053158659_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_0000002340063016__en-us_topic_0053158659_row111036271506"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002340063016__en-us_topic_0053158659_p56885004">server_id</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002340063016__en-us_topic_0053158659_p44282627">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002340063016__en-us_topic_0053158659_p30123063">Specifies the <span id="EN-US_TOPIC_0000002340063016__en-us_topic_0053158659_text1001475119">BMS</span><span id="EN-US_TOPIC_0000002340063016__en-us_topic_0053158659_text9024761115"></span><span id="EN-US_TOPIC_0000002340063016__en-us_topic_0053158659_text599164243212"></span> ID.</p>
<p id="EN-US_TOPIC_0000002340063016__en-us_topic_0053158659_p29791113277">You can obtain the BMS ID from the <span id="EN-US_TOPIC_0000002340063016__en-us_topic_0053158659_en-us_topic_0113746489_text895314101319">BMS</span><span id="EN-US_TOPIC_0000002340063016__en-us_topic_0053158659_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_0000002340063016__en-us_topic_0053158659_section7670737"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002340063016__en-us_topic_0053158659_table48180537" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0000002340063016__en-us_topic_0053158659_row15499871"><th align="left" class="cellrowborder" valign="top" width="14.05%" id="mcps1.3.3.2.1.5.1.1"><p id="EN-US_TOPIC_0000002340063016__en-us_topic_0053158659_p59978491115233">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.05%" id="mcps1.3.3.2.1.5.1.2"><p id="EN-US_TOPIC_0000002340063016__en-us_topic_0053158659_p17403183919111">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="23.080000000000002%" id="mcps1.3.3.2.1.5.1.3"><p id="EN-US_TOPIC_0000002340063016__en-us_topic_0053158659_p26419641115233">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="48.82%" id="mcps1.3.3.2.1.5.1.4"><p id="EN-US_TOPIC_0000002340063016__en-us_topic_0053158659_p64181866115233">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002340063016__en-us_topic_0053158659_row54897010"><td class="cellrowborder" valign="top" width="14.05%" headers="mcps1.3.3.2.1.5.1.1 "><p id="EN-US_TOPIC_0000002340063016__en-us_topic_0053158659_p17472816">os-start</p>
</td>
<td class="cellrowborder" valign="top" width="14.05%" headers="mcps1.3.3.2.1.5.1.2 "><p id="EN-US_TOPIC_0000002340063016__en-us_topic_0053158659_p74009391212">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="23.080000000000002%" headers="mcps1.3.3.2.1.5.1.3 "><p id="EN-US_TOPIC_0000002340063016__en-us_topic_0053158659_p17209562">null</p>
</td>
<td class="cellrowborder" valign="top" width="48.82%" headers="mcps1.3.3.2.1.5.1.4 "><p id="EN-US_TOPIC_0000002340063016__en-us_topic_0053158659_p63522246">Specifies the operation of starting the <span id="EN-US_TOPIC_0000002340063016__en-us_topic_0053158659_text5483653171111">BMS</span><span id="EN-US_TOPIC_0000002340063016__en-us_topic_0053158659_text1348315319117"></span><span id="EN-US_TOPIC_0000002340063016__en-us_topic_0053158659_text647914505323"></span>. The data structure is empty.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000002340063016__en-us_topic_0053158659_section1755333173317"><h4 class="sectiontitle">Example Request</h4><div class="p" id="EN-US_TOPIC_0000002340063016__en-us_topic_0053158659_p73131944134815">Starting a <span id="EN-US_TOPIC_0000002340063016__en-us_topic_0053158659_text266731472811">BMS</span><span id="EN-US_TOPIC_0000002340063016__en-us_topic_0053158659_text7802430369"></span><span id="EN-US_TOPIC_0000002340063016__en-us_topic_0053158659_text549771912419"></span> (ID: 95bf2490-5428-432c-ad9b-5e3406f869dd)<div class="codecoloring" codetype="Java" id="EN-US_TOPIC_0000002340063016__en-us_topic_0053158659_screen17473125016348"><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_0000002340063016__en-us_topic_0053158659_screen1452063193959"><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-start&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{}</span>
<span class="w"> </span><span class="p">}</span>
</pre></div></td></tr></table></div>
</div>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000002340063016__en-us_topic_0053158659_section1927776"><h4 class="sectiontitle">Response</h4><p id="EN-US_TOPIC_0000002340063016__en-us_topic_0053158659_p45028263">N/A</p>
</div>
<div class="section" id="EN-US_TOPIC_0000002340063016__en-us_topic_0053158659_section17349988"><h4 class="sectiontitle">Returned Values</h4><div class="p" id="EN-US_TOPIC_0000002340063016__en-us_topic_0053158659_p1271142611013">Normal values
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002340063016__en-us_topic_0053158659_table753804619176" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0000002340063016__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_0000002340063016__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_0000002340063016__en-us_topic_0053158659_p207355465176">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002340063016__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_0000002340063016__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_0000002340063016__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_0000002340063016__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_0000002340063016__en-us_topic_0053158659_section14752650154917"><h4 class="sectiontitle">Error Codes</h4><p id="EN-US_TOPIC_0000002340063016__en-us_topic_0053158659_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>