forked from docs/doc-exports
Reviewed-by: Pristromskaia, Margarita <margarita.pristromskaia@t-systems.com> Co-authored-by: guoyanyan <guoyanyan3@huawei.com> Co-committed-by: guoyanyan <guoyanyan3@huawei.com>
252 lines
21 KiB
HTML
252 lines
21 KiB
HTML
<a name="EN-US_TOPIC_0131356393"></a><a name="EN-US_TOPIC_0131356393"></a>
|
|
|
|
<h1 class="topictitle1">Stopping BMSs</h1>
|
|
<div id="body1536986565099"><div class="section" id="EN-US_TOPIC_0131356393__section14270750"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0131356393__p25253189">This API is used to stop BMSs of specified IDs. You can stop a maximum of 1000 BMSs at a time.</p>
|
|
<div class="note" id="EN-US_TOPIC_0131356393__note780312121511"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="EN-US_TOPIC_0131356393__p38039121118">This is an asynchronous API. Calling the API successfully indicates that the task is delivered successfully. To check whether the task is successful, use the <a href="en-us_topic_0118696596.html">Querying Task Statuses</a> API.</p>
|
|
</div></div>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0131356393__section61327894"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0131356393__p65852633155046">POST /v1/{project_id}/baremetalservers/action</p>
|
|
<div class="p" id="EN-US_TOPIC_0131356393__p21311526115013"><a href="#EN-US_TOPIC_0131356393__table66418347">Table 1</a> lists the parameters.
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0131356393__table66418347"></a><a name="table66418347"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0131356393__table66418347" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0131356393__row49507636"><th align="left" class="cellrowborder" valign="top" width="19.05%" id="mcps1.3.2.3.2.2.4.1.1"><p id="EN-US_TOPIC_0131356393__p50695543">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20.549999999999997%" id="mcps1.3.2.3.2.2.4.1.2"><p id="EN-US_TOPIC_0131356393__p12698356">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60.4%" id="mcps1.3.2.3.2.2.4.1.3"><p id="EN-US_TOPIC_0131356393__p21933905">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0131356393__row31815862"><td class="cellrowborder" valign="top" width="19.05%" headers="mcps1.3.2.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0131356393__p26948044">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.549999999999997%" headers="mcps1.3.2.3.2.2.4.1.2 "><p id="EN-US_TOPIC_0131356393__p35307962">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60.4%" headers="mcps1.3.2.3.2.2.4.1.3 "><p id="EN-US_TOPIC_0131356393__p37593705">Specifies the project ID.</p>
|
|
<p id="EN-US_TOPIC_0131356393__p652825144113">For details about how to obtain the project ID, see <a href="en-us_topic_0171277624.html">Obtaining a Project ID</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0131356393__section15080136"><h4 class="sectiontitle">Request</h4><ul id="EN-US_TOPIC_0131356393__ul28828491"><li id="EN-US_TOPIC_0131356393__li10896009">Request parameters<div class="note" id="EN-US_TOPIC_0131356393__note228197219428"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="EN-US_TOPIC_0131356393__p2053774919428">In the request, the parameters to stop BMSs must be sent using field <strong id="EN-US_TOPIC_0131356393__b146191934132016">os-stop</strong>. For details, see the example request.</p>
|
|
</div></div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0131356393__table12156768" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0131356393__row44143566"><th align="left" class="cellrowborder" valign="top" width="16.538346165383462%" id="mcps1.3.3.2.1.2.1.5.1.1"><p id="EN-US_TOPIC_0131356393__p18859061">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="19.73802619738026%" id="mcps1.3.3.2.1.2.1.5.1.2"><p id="EN-US_TOPIC_0131356393__p51188993">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="24.437556244375564%" id="mcps1.3.3.2.1.2.1.5.1.3"><p id="EN-US_TOPIC_0131356393__p52667802">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="39.28607139286072%" id="mcps1.3.3.2.1.2.1.5.1.4"><p id="EN-US_TOPIC_0131356393__p38233575">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0131356393__row9911889"><td class="cellrowborder" valign="top" width="16.538346165383462%" headers="mcps1.3.3.2.1.2.1.5.1.1 "><p id="EN-US_TOPIC_0131356393__p64665535">os-stop</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.73802619738026%" headers="mcps1.3.3.2.1.2.1.5.1.2 "><p id="EN-US_TOPIC_0131356393__p3416986">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="24.437556244375564%" headers="mcps1.3.3.2.1.2.1.5.1.3 "><p id="EN-US_TOPIC_0131356393__p8340425">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.28607139286072%" headers="mcps1.3.3.2.1.2.1.5.1.4 "><p id="EN-US_TOPIC_0131356393__p40372317">Specifies the operation to stop BMSs. For details, see <a href="#EN-US_TOPIC_0131356393__table51053190162024">Table 2</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0131356393__table51053190162024"></a><a name="table51053190162024"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0131356393__table51053190162024" frame="border" border="1" rules="all"><caption><b>Table 2 </b><strong id="EN-US_TOPIC_0131356393__b1731211019258">os-stop</strong> field data structure description</caption><thead align="left"><tr id="EN-US_TOPIC_0131356393__row27328423162024"><th align="left" class="cellrowborder" valign="top" width="16.538346165383462%" id="mcps1.3.3.2.1.3.2.5.1.1"><p id="EN-US_TOPIC_0131356393__p66118637162024">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="19.73802619738026%" id="mcps1.3.3.2.1.3.2.5.1.2"><p id="EN-US_TOPIC_0131356393__p54009417162024">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="24.437556244375564%" id="mcps1.3.3.2.1.3.2.5.1.3"><p id="EN-US_TOPIC_0131356393__p12686624162024">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="39.28607139286072%" id="mcps1.3.3.2.1.3.2.5.1.4"><p id="EN-US_TOPIC_0131356393__p20983644162024">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0131356393__row21953637162024"><td class="cellrowborder" valign="top" width="16.538346165383462%" headers="mcps1.3.3.2.1.3.2.5.1.1 "><p id="EN-US_TOPIC_0131356393__p33414178162024">servers</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.73802619738026%" headers="mcps1.3.3.2.1.3.2.5.1.2 "><p id="EN-US_TOPIC_0131356393__p22193916162024">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="24.437556244375564%" headers="mcps1.3.3.2.1.3.2.5.1.3 "><p id="EN-US_TOPIC_0131356393__p52876762162024">Array of objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.28607139286072%" headers="mcps1.3.3.2.1.3.2.5.1.4 "><p id="EN-US_TOPIC_0131356393__p26671950162024">Specifies BMS IDs. For details, see <a href="#EN-US_TOPIC_0131356393__table48932206">Table 3</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0131356393__row8227700141926"><td class="cellrowborder" valign="top" width="16.538346165383462%" headers="mcps1.3.3.2.1.3.2.5.1.1 "><p id="EN-US_TOPIC_0131356393__p62463948141926">type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.73802619738026%" headers="mcps1.3.3.2.1.3.2.5.1.2 "><p id="EN-US_TOPIC_0131356393__p26415004141926">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="24.437556244375564%" headers="mcps1.3.3.2.1.3.2.5.1.3 "><p id="EN-US_TOPIC_0131356393__p59240589141926">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.28607139286072%" headers="mcps1.3.3.2.1.3.2.5.1.4 "><p id="EN-US_TOPIC_0131356393__p33758406141926">Specifies the BMS stop type.</p>
|
|
<ul id="EN-US_TOPIC_0131356393__ul251735085216"><li id="EN-US_TOPIC_0131356393__li105171350125220"><strong id="EN-US_TOPIC_0131356393__b276545204513">SOFT</strong>: soft stop (invalid)</li><li id="EN-US_TOPIC_0131356393__li1751745015524"><strong id="EN-US_TOPIC_0131356393__b425544614512">HARD</strong>: hard stop (default)</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0131356393__table48932206"></a><a name="table48932206"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0131356393__table48932206" frame="border" border="1" rules="all"><caption><b>Table 3 </b><strong id="EN-US_TOPIC_0131356393__b5334121392716">servers</strong> field data structure description</caption><thead align="left"><tr id="EN-US_TOPIC_0131356393__row2750866"><th align="left" class="cellrowborder" valign="top" width="16.728327167283272%" id="mcps1.3.3.2.1.4.2.5.1.1"><p id="EN-US_TOPIC_0131356393__p21493617">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="19.548045195480455%" id="mcps1.3.3.2.1.4.2.5.1.2"><p id="EN-US_TOPIC_0131356393__p63261412">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="24.437556244375564%" id="mcps1.3.3.2.1.4.2.5.1.3"><p id="EN-US_TOPIC_0131356393__p23900756">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="39.28607139286072%" id="mcps1.3.3.2.1.4.2.5.1.4"><p id="EN-US_TOPIC_0131356393__p56913064">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0131356393__row46555465"><td class="cellrowborder" valign="top" width="16.728327167283272%" headers="mcps1.3.3.2.1.4.2.5.1.1 "><p id="EN-US_TOPIC_0131356393__p12896286">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.548045195480455%" headers="mcps1.3.3.2.1.4.2.5.1.2 "><p id="EN-US_TOPIC_0131356393__p37966223">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="24.437556244375564%" headers="mcps1.3.3.2.1.4.2.5.1.3 "><p id="EN-US_TOPIC_0131356393__p55365254">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.28607139286072%" headers="mcps1.3.3.2.1.4.2.5.1.4 "><p id="EN-US_TOPIC_0131356393__p28842926">Specifies the BMS ID.</p>
|
|
<p id="EN-US_TOPIC_0131356393__p29791113277">You can obtain the BMS ID from the <span id="EN-US_TOPIC_0131356393__en-us_topic_0113746489_text013014803615">BMS</span><span id="EN-US_TOPIC_0131356393__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>
|
|
</li><li id="EN-US_TOPIC_0131356393__li6187917175316">Example request<div class="codecoloring" codetype="Java" id="EN-US_TOPIC_0131356393__screen164279403365"><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">//{BMS Endpoint}/v1/bbf1946d374b44a0a2a95533562ba954/baremetalservers/action</span>
|
|
</pre></div></td></tr></table></div>
|
|
|
|
</div>
|
|
<div class="codecoloring" codetype="Java" id="EN-US_TOPIC_0131356393__screen41547899194556"><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>
|
|
<span class="normal"> 6</span>
|
|
<span class="normal"> 7</span>
|
|
<span class="normal"> 8</span>
|
|
<span class="normal"> 9</span>
|
|
<span class="normal">10</span>
|
|
<span class="normal">11</span>
|
|
<span class="normal">12</span>
|
|
<span class="normal">13</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="w"> </span><span class="s">"type"</span><span class="p">:</span><span class="w"> </span><span class="s">"HARD"</span><span class="p">,</span>
|
|
<span class="w"> </span><span class="s">"servers"</span><span class="p">:</span><span class="w"> </span><span class="o">[</span>
|
|
<span class="w"> </span><span class="p">{</span>
|
|
<span class="w"> </span><span class="s">"id"</span><span class="p">:</span><span class="w"> </span><span class="s">"616fb98f-46ca-475e-917e-2563e5a8cd19"</span>
|
|
<span class="w"> </span><span class="p">},</span>
|
|
<span class="w"> </span><span class="p">{</span>
|
|
<span class="w"> </span><span class="s">"id"</span><span class="p">:</span><span class="w"> </span><span class="s">"726fb98f-46ca-475e-917e-2563e5a8cd20"</span>
|
|
<span class="w"> </span><span class="p">}</span>
|
|
<span class="w"> </span><span class="o">]</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_0131356393__section1503503"><h4 class="sectiontitle">Response</h4><ul id="EN-US_TOPIC_0131356393__ul1725210128129"><li id="EN-US_TOPIC_0131356393__li1825217127121">Normal response</li></ul>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0131356393__table757167711151" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Normal response</caption><thead align="left"><tr id="EN-US_TOPIC_0131356393__row5251903911151"><th align="left" class="cellrowborder" valign="top" width="19.86%" id="mcps1.3.4.3.2.4.1.1"><p id="EN-US_TOPIC_0131356393__p2618376611151">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="23.669999999999998%" id="mcps1.3.4.3.2.4.1.2"><p id="EN-US_TOPIC_0131356393__p4051029311151">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="56.47%" id="mcps1.3.4.3.2.4.1.3"><p id="EN-US_TOPIC_0131356393__p6010832511151">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0131356393__row3693617411151"><td class="cellrowborder" valign="top" width="19.86%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0131356393__p3904008711151">job_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23.669999999999998%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0131356393__p813044011151">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.47%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0131356393__p193921820174211">Specifies the task ID returned after a task command is issued. The task ID can be used to query the execution status of the task.</p>
|
|
<p id="EN-US_TOPIC_0131356393__p5458589811151">For details about how to query the task execution status based on <strong id="EN-US_TOPIC_0131356393__b114119213173">job_id</strong>, see <a href="en-us_topic_0118696596.html">Querying Task Statuses</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<ul id="EN-US_TOPIC_0131356393__ul156821631217"><li id="EN-US_TOPIC_0131356393__li9705165126">Abnormal response</li></ul>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0131356393__table6467239411151" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Abnormal response</caption><thead align="left"><tr id="EN-US_TOPIC_0131356393__row2581079811151"><th align="left" class="cellrowborder" valign="top" width="19.93%" id="mcps1.3.4.5.2.4.1.1"><p id="EN-US_TOPIC_0131356393__p1029990211151">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="23.69%" id="mcps1.3.4.5.2.4.1.2"><p id="EN-US_TOPIC_0131356393__p2898571411151">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="56.379999999999995%" id="mcps1.3.4.5.2.4.1.3"><p id="EN-US_TOPIC_0131356393__p6614149111151">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0131356393__row5586052011151"><td class="cellrowborder" valign="top" width="19.93%" headers="mcps1.3.4.5.2.4.1.1 "><p id="EN-US_TOPIC_0131356393__p2840824911151">error</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23.69%" headers="mcps1.3.4.5.2.4.1.2 "><p id="EN-US_TOPIC_0131356393__p1936686411151">Dictionary data structure</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.379999999999995%" headers="mcps1.3.4.5.2.4.1.3 "><p id="EN-US_TOPIC_0131356393__p2558244011151">Specifies the error returned when a task submission encounters an exception. For details, see <a href="#EN-US_TOPIC_0131356393__table6409189311151">Table 6</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0131356393__table6409189311151"></a><a name="table6409189311151"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0131356393__table6409189311151" frame="border" border="1" rules="all"><caption><b>Table 6 </b><strong id="EN-US_TOPIC_0131356393__b4217161710018">error</strong> data structure</caption><thead align="left"><tr id="EN-US_TOPIC_0131356393__row2324327311151"><th align="left" class="cellrowborder" valign="top" width="20.169999999999998%" id="mcps1.3.4.6.2.4.1.1"><p id="EN-US_TOPIC_0131356393__p365693111151">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="23.369999999999997%" id="mcps1.3.4.6.2.4.1.2"><p id="EN-US_TOPIC_0131356393__p2777597711151">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="56.46%" id="mcps1.3.4.6.2.4.1.3"><p id="EN-US_TOPIC_0131356393__p3526170111151">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0131356393__row3762550011151"><td class="cellrowborder" valign="top" width="20.169999999999998%" headers="mcps1.3.4.6.2.4.1.1 "><p id="EN-US_TOPIC_0131356393__p2776668011151">message</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23.369999999999997%" headers="mcps1.3.4.6.2.4.1.2 "><p id="EN-US_TOPIC_0131356393__p3450864111151">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.46%" headers="mcps1.3.4.6.2.4.1.3 "><p id="EN-US_TOPIC_0131356393__p4373654211151">Specifies the error message.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0131356393__row5808456411151"><td class="cellrowborder" valign="top" width="20.169999999999998%" headers="mcps1.3.4.6.2.4.1.1 "><p id="EN-US_TOPIC_0131356393__p722924311151">code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23.369999999999997%" headers="mcps1.3.4.6.2.4.1.2 "><p id="EN-US_TOPIC_0131356393__p4869780211151">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.46%" headers="mcps1.3.4.6.2.4.1.3 "><p id="EN-US_TOPIC_0131356393__p5220791411151">Specifies the error code.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0131356393__section19874359153411"><h4 class="sectiontitle">Example response</h4><ul id="EN-US_TOPIC_0131356393__ul1934615883519"><li id="EN-US_TOPIC_0131356393__li834615803516">Normal response<div class="codecoloring" codetype="Java" id="EN-US_TOPIC_0131356393__screen3351794620424"><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="w"> </span><span class="s">"job_id"</span><span class="p">:</span><span class="w"> </span><span class="s">"70a599e0-31e7-49b7-b260-868f441e862b"</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_0131356393__section868814916514"><h4 class="sectiontitle">Returned Values</h4><div class="p" id="EN-US_TOPIC_0131356393__en-us_topic_0106040941_p193201622141412">Normal values
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0131356393__en-us_topic_0106040941_table753804619176" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0131356393__en-us_topic_0106040941_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_0131356393__en-us_topic_0106040941_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_0131356393__en-us_topic_0106040941_p207355465176">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0131356393__en-us_topic_0106040941_row1473514621713"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.6.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0131356393__en-us_topic_0106040941_p13735144611178">200</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_0131356393__en-us_topic_0106040941_p207351246161711">The request has been successfully processed.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<p id="EN-US_TOPIC_0131356393__en-us_topic_0106040941_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_0131356393__section14752650154917"><h4 class="sectiontitle">Error Codes</h4><p id="EN-US_TOPIC_0131356393__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_0113746490.html">BMS Status Management</a></div>
|
|
</div>
|
|
</div>
|
|
|