vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/bms/api-ref/en-us_topic_0118696596.html
guoyanyan c311ecafe3 bms_api_0510 
Reviewed-by: Pristromskaia, Margarita <margarita.pristromskaia@t-systems.com>
Co-authored-by: guoyanyan <guoyanyan3@huawei.com>
Co-committed-by: guoyanyan <guoyanyan3@huawei.com>
2023-10-11 08:28:11 +00:00

355 lines
34 KiB
HTML
Raw Blame History

<a name="EN-US_TOPIC_0118696596"></a><a name="EN-US_TOPIC_0118696596"></a>
<h1 class="topictitle1">Querying Task Statuses</h1>
<div id="body1529984571622"><div class="section" id="EN-US_TOPIC_0118696596__section1145624712615"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0118696596__p119019219372">This API is used to query the execution status of a task.</p>
<p id="EN-US_TOPIC_0118696596__p58914097194855">After a task, such as creating a <span id="EN-US_TOPIC_0118696596__text11602822115310">BMS</span><span id="EN-US_TOPIC_0118696596__text1060218229533"></span> or attaching disks, is delivered, <strong id="EN-US_TOPIC_0118696596__b1260116275589">job_id</strong> is returned, based on which you can query the execution status of the task.</p>
</div>
<div class="section" id="EN-US_TOPIC_0118696596__section12499172418819"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0118696596__p52270865163249">GET /v1/{project_id}/jobs/{job_id}</p>
<p id="EN-US_TOPIC_0118696596__p6344639141320"><a href="#EN-US_TOPIC_0118696596__table108782505134">Table 1</a> lists the parameters.</p>
<div class="tablenoborder"><a name="EN-US_TOPIC_0118696596__table108782505134"></a><a name="table108782505134"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0118696596__table108782505134" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0118696596__row087915031315"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.2.4.2.4.1.1"><p id="EN-US_TOPIC_0118696596__p2450228144">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_0118696596__p164531028144">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_0118696596__p845682121415">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0118696596__row198791550121313"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.4.2.4.1.1 "><p id="EN-US_TOPIC_0118696596__p1646042151413">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_0118696596__p6463182161412">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_0118696596__p64651423146">Specifies the project ID.</p>
<p id="EN-US_TOPIC_0118696596__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>
<tr id="EN-US_TOPIC_0118696596__row18879175019131"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.4.2.4.1.1 "><p id="EN-US_TOPIC_0118696596__p194675214146">job_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_0118696596__p1747012171413">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_0118696596__p04739215149">Specifies the task ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0118696596__section1707915201018"><h4 class="sectiontitle">Request</h4><ul id="EN-US_TOPIC_0118696596__ul11787517123414"><li id="EN-US_TOPIC_0118696596__li181404514475">Request parameters<p id="EN-US_TOPIC_0118696596__p925655134713"><a name="EN-US_TOPIC_0118696596__li181404514475"></a><a name="li181404514475"></a>None</p>
</li><li id="EN-US_TOPIC_0118696596__li1678881713347">Example request<div class="codecoloring" codetype="Java" id="EN-US_TOPIC_0118696596__screen61093281343"><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">GET</span><span class="w"> </span><span class="n">https</span><span class="p">:</span><span class="c1">//{BMS Endpoint}/v1/bbf1946d374b44a0a2a95533562ba954/jobs/2c9eb2c5544cbf6101544f0635672b60</span>
</pre></div></td></tr></table></div>
</div>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0118696596__section32178181210"><h4 class="sectiontitle">Response</h4><ul id="EN-US_TOPIC_0118696596__ul116471220181512"><li id="EN-US_TOPIC_0118696596__li16647020111515">Response parameters
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0118696596__table63003337163851" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0118696596__row65296242163851"><th align="left" class="cellrowborder" valign="top" width="24.59%" id="mcps1.3.4.2.1.1.1.4.1.1"><p id="EN-US_TOPIC_0118696596__p54504213163851">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="24.59%" id="mcps1.3.4.2.1.1.1.4.1.2"><p id="EN-US_TOPIC_0118696596__p52765170163851">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50.82%" id="mcps1.3.4.2.1.1.1.4.1.3"><p id="EN-US_TOPIC_0118696596__p46120367163851">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0118696596__row44762228163851"><td class="cellrowborder" valign="top" width="24.59%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0118696596__p20905868102821">status</p>
</td>
<td class="cellrowborder" valign="top" width="24.59%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0118696596__p15653760102821">String</p>
</td>
<td class="cellrowborder" valign="top" width="50.82%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0118696596__p3084195102821">Specifies the task status.</p>
<ul id="EN-US_TOPIC_0118696596__ul27757760102821"><li id="EN-US_TOPIC_0118696596__li48493251102821"><strong id="EN-US_TOPIC_0118696596__b96401750154913">SUCCESS</strong>: The task is successful.</li><li id="EN-US_TOPIC_0118696596__li33786077102821"><strong id="EN-US_TOPIC_0118696596__b937855924915">RUNNING</strong>: The task is running.</li><li id="EN-US_TOPIC_0118696596__li35639239102821"><strong id="EN-US_TOPIC_0118696596__b122688710502">FAIL</strong>: The task failed.</li><li id="EN-US_TOPIC_0118696596__li52317698102821"><strong id="EN-US_TOPIC_0118696596__b1637401285011">INIT</strong>: The task is being initialized.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0118696596__row17040455163851"><td class="cellrowborder" valign="top" width="24.59%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0118696596__p21767581102821">entities</p>
</td>
<td class="cellrowborder" valign="top" width="24.59%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0118696596__p18343614102821">Object</p>
</td>
<td class="cellrowborder" valign="top" width="50.82%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0118696596__p78921950203711">Specifies the task object. For details, see <a href="#EN-US_TOPIC_0118696596__table63816992163249">Table 2</a>.</p>
<p id="EN-US_TOPIC_0118696596__p17831309102821">The displayed information varies depending on the task type. For operations related to <span id="EN-US_TOPIC_0118696596__text1027592519399">BMS</span><span id="EN-US_TOPIC_0118696596__text1968164914717"></span>s, <strong id="EN-US_TOPIC_0118696596__b6591930191011">server_id</strong> is displayed. For operations related to NICs, <strong id="EN-US_TOPIC_0118696596__b12501721121112">nic_id</strong> is displayed. If subtasks exist, details about the subtasks are also displayed.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0118696596__row51515112163851"><td class="cellrowborder" valign="top" width="24.59%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0118696596__p47013726102821">job_id</p>
</td>
<td class="cellrowborder" valign="top" width="24.59%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0118696596__p50015490102821">String</p>
</td>
<td class="cellrowborder" valign="top" width="50.82%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0118696596__p21179423102821">Specifies the task ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0118696596__row25971152163851"><td class="cellrowborder" valign="top" width="24.59%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0118696596__p4761320102821">job_type</p>
</td>
<td class="cellrowborder" valign="top" width="24.59%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0118696596__p50122638102821">String</p>
</td>
<td class="cellrowborder" valign="top" width="50.82%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0118696596__p32181178102821">Specifies the task type. The value can be:</p>
<ul id="EN-US_TOPIC_0118696596__ul1381913613363"><li id="EN-US_TOPIC_0118696596__li635812471301"><strong id="EN-US_TOPIC_0118696596__b1986064834912">baremetalBatchCreate</strong>: creating <span id="EN-US_TOPIC_0118696596__text355864965317">BMS</span><span id="EN-US_TOPIC_0118696596__text9558114975316"></span>s in a batch</li><li id="EN-US_TOPIC_0118696596__li114411319192914"><strong id="EN-US_TOPIC_0118696596__b540218252506">baremetalBatchOperate</strong>: changing the power status of <span id="EN-US_TOPIC_0118696596__text1836716524531">BMS</span><span id="EN-US_TOPIC_0118696596__text1836755215534"></span>s in a batch.</li><li id="EN-US_TOPIC_0118696596__li746510214017"><strong id="EN-US_TOPIC_0118696596__b132054430376">baremetalAttachVolume</strong>: attaching a disk</li><li id="EN-US_TOPIC_0118696596__li7581477456"><strong id="EN-US_TOPIC_0118696596__b192141848385">baremetalDetachVolume</strong>: detaching a disk</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0118696596__row37164860163851"><td class="cellrowborder" valign="top" width="24.59%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0118696596__p39085626102821">begin_time</p>
</td>
<td class="cellrowborder" valign="top" width="24.59%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0118696596__p11819105102821">String</p>
</td>
<td class="cellrowborder" valign="top" width="50.82%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0118696596__p26193501102821">Specifies the time when the job started.</p>
<p id="EN-US_TOPIC_0118696596__p8261133915368">The timestamp format is ISO 8601, for example, <strong id="EN-US_TOPIC_0118696596__b208046226177">2019-04-25T20:04:47.591Z</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0118696596__row15772661163851"><td class="cellrowborder" valign="top" width="24.59%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0118696596__p36144979102821">end_time</p>
</td>
<td class="cellrowborder" valign="top" width="24.59%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0118696596__p42062205102821">String</p>
</td>
<td class="cellrowborder" valign="top" width="50.82%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0118696596__p61705735102821">Specifies the time when the job ended.</p>
<p id="EN-US_TOPIC_0118696596__p4767114253718">The timestamp format is ISO 8601, for example, <strong id="EN-US_TOPIC_0118696596__b156457477171">2019-04-26T20:04:47.591Z</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0118696596__row58136329163851"><td class="cellrowborder" valign="top" width="24.59%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0118696596__p20542517102821">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="24.59%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0118696596__p53331169102821">String</p>
</td>
<td class="cellrowborder" valign="top" width="50.82%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0118696596__p22389946102821">Specifies the error code returned upon a task execution failure.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0118696596__row26946447163851"><td class="cellrowborder" valign="top" width="24.59%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0118696596__p14816990102821">fail_reason</p>
</td>
<td class="cellrowborder" valign="top" width="24.59%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0118696596__p59325580102821">String</p>
</td>
<td class="cellrowborder" valign="top" width="50.82%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0118696596__p30239861102821">Specifies the cause of a task execution failure.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0118696596__row41958503163851"><td class="cellrowborder" valign="top" width="24.59%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0118696596__p33151312102821">message</p>
</td>
<td class="cellrowborder" valign="top" width="24.59%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0118696596__p901760102821">String</p>
</td>
<td class="cellrowborder" valign="top" width="50.82%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0118696596__p53403447102821">Specifies the message returned when an error occurs.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0118696596__row47258102163851"><td class="cellrowborder" valign="top" width="24.59%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0118696596__p7972234102821">code</p>
</td>
<td class="cellrowborder" valign="top" width="24.59%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0118696596__p41771195102821">String</p>
</td>
<td class="cellrowborder" valign="top" width="50.82%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0118696596__p50886402102821">Specifies the error code returned when an error occurs.</p>
<p id="EN-US_TOPIC_0118696596__p55324436102821">For details about error codes, see section <a href="en-us_topic_0053158690.html">Status Codes</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0118696596__table63816992163249"></a><a name="table63816992163249"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0118696596__table63816992163249" frame="border" border="1" rules="all"><caption><b>Table 2 </b><strong id="EN-US_TOPIC_0118696596__b289419341914">entities</strong> field data structure description</caption><thead align="left"><tr id="EN-US_TOPIC_0118696596__row25378569163249"><th align="left" class="cellrowborder" valign="top" width="23.932393239323932%" id="mcps1.3.4.2.1.2.2.4.1.1"><p id="EN-US_TOPIC_0118696596__p38741046114219">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="31.83318331833183%" id="mcps1.3.4.2.1.2.2.4.1.2"><p id="EN-US_TOPIC_0118696596__p687612460429">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="44.23442344234424%" id="mcps1.3.4.2.1.2.2.4.1.3"><p id="EN-US_TOPIC_0118696596__p20879104611427">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0118696596__row21068325163249"><td class="cellrowborder" valign="top" width="23.932393239323932%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0118696596__p1987866102840">sub_jobs_total</p>
</td>
<td class="cellrowborder" valign="top" width="31.83318331833183%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0118696596__p26799477102840">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="44.23442344234424%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0118696596__p23274041102840">Specifies the number of subtasks. If the task has no subtasks, the value of this parameter is <strong id="EN-US_TOPIC_0118696596__b51551332123313">0</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0118696596__row1957164017643"><td class="cellrowborder" valign="top" width="23.932393239323932%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0118696596__p55342196102840">sub_jobs</p>
</td>
<td class="cellrowborder" valign="top" width="31.83318331833183%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0118696596__p53532900102840">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="44.23442344234424%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0118696596__p35234299102840">Specifies the execution information about a subtask. If the task has no subtasks, the value of this parameter is left blank. For details, see <a href="#EN-US_TOPIC_0118696596__table1500801817135">Table 3</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0118696596__table1500801817135"></a><a name="table1500801817135"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0118696596__table1500801817135" frame="border" border="1" rules="all"><caption><b>Table 3 </b><strong id="EN-US_TOPIC_0118696596__b19233161123618">sub_jobs</strong> field data structure description</caption><thead align="left"><tr id="EN-US_TOPIC_0118696596__row5502467917135"><th align="left" class="cellrowborder" valign="top" width="23.93%" id="mcps1.3.4.2.1.3.2.4.1.1"><p id="EN-US_TOPIC_0118696596__p14352122417435">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="23.75%" id="mcps1.3.4.2.1.3.2.4.1.2"><p id="EN-US_TOPIC_0118696596__p153558241436">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="52.32%" id="mcps1.3.4.2.1.3.2.4.1.3"><p id="EN-US_TOPIC_0118696596__p8357122474310">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0118696596__row3836327417140"><td class="cellrowborder" valign="top" width="23.93%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0118696596__p5596555610290">status</p>
</td>
<td class="cellrowborder" valign="top" width="23.75%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0118696596__p3691618110290">String</p>
</td>
<td class="cellrowborder" valign="top" width="52.32%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="EN-US_TOPIC_0118696596__p124153110290">Specifies the task status.</p>
<ul id="EN-US_TOPIC_0118696596__ul1117378710290"><li id="EN-US_TOPIC_0118696596__li3345522610290"><strong id="EN-US_TOPIC_0118696596__b38915186366">SUCCESS</strong>: The task is successful.</li><li id="EN-US_TOPIC_0118696596__li3266158610290"><strong id="EN-US_TOPIC_0118696596__b49711221360">RUNNING</strong>: The task is running.</li><li id="EN-US_TOPIC_0118696596__li2551881810290"><strong id="EN-US_TOPIC_0118696596__b546323193619">FAIL</strong>: The task failed.</li><li id="EN-US_TOPIC_0118696596__li2834277210290"><strong id="EN-US_TOPIC_0118696596__b1564712437362">INIT</strong>: The task is being initialized.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0118696596__row1171912617140"><td class="cellrowborder" valign="top" width="23.93%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0118696596__p5946004210290">entities</p>
</td>
<td class="cellrowborder" valign="top" width="23.75%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0118696596__p5153410710290">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="52.32%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="EN-US_TOPIC_0118696596__p5450940410290">Specifies the task object. The displayed information varies depending on the task type. For operations related to <span id="EN-US_TOPIC_0118696596__text17249209105512">BMS</span><span id="EN-US_TOPIC_0118696596__text142491299553"></span>s, <strong id="EN-US_TOPIC_0118696596__b13261203212384">server_id</strong> is displayed. For operations related to NICs, <strong id="EN-US_TOPIC_0118696596__b112860545382">nic_id</strong> is displayed.</p>
<p id="EN-US_TOPIC_0118696596__p1645004534016">For details, see <a href="#EN-US_TOPIC_0118696596__table2577901102930">Table 4</a>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0118696596__row875866517140"><td class="cellrowborder" valign="top" width="23.93%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0118696596__p890825710290">job_id</p>
</td>
<td class="cellrowborder" valign="top" width="23.75%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0118696596__p5048019610290">String</p>
</td>
<td class="cellrowborder" valign="top" width="52.32%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="EN-US_TOPIC_0118696596__p2440551510290">Specifies the task ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0118696596__row3079934617140"><td class="cellrowborder" valign="top" width="23.93%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0118696596__p777215910290">job_type</p>
</td>
<td class="cellrowborder" valign="top" width="23.75%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0118696596__p2556517210290">String</p>
</td>
<td class="cellrowborder" valign="top" width="52.32%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="EN-US_TOPIC_0118696596__p4785561910290">Specifies the task type. The value can be:</p>
<ul id="EN-US_TOPIC_0118696596__ul767111320272"><li id="EN-US_TOPIC_0118696596__li10169945143110"><strong id="EN-US_TOPIC_0118696596__b5170102110511">baremetalSingleCreate</strong>: creating a single <span id="EN-US_TOPIC_0118696596__text1825012125551">BMS</span><span id="EN-US_TOPIC_0118696596__text8250131217551"></span></li><li id="EN-US_TOPIC_0118696596__li16714135279"><strong id="EN-US_TOPIC_0118696596__b72194416518">baremetalSingleOperate</strong>: changing the power status of a single <span id="EN-US_TOPIC_0118696596__text14253141475512">BMS</span><span id="EN-US_TOPIC_0118696596__text182531614125517"></span></li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0118696596__row6307447317140"><td class="cellrowborder" valign="top" width="23.93%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0118696596__p5724624610290">begin_time</p>
</td>
<td class="cellrowborder" valign="top" width="23.75%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0118696596__p643434910290">String</p>
</td>
<td class="cellrowborder" valign="top" width="52.32%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="EN-US_TOPIC_0118696596__p6012909110290">Specifies the time when the job started.</p>
<p id="EN-US_TOPIC_0118696596__p196331548193717">The timestamp format is ISO 8601, for example, <strong id="EN-US_TOPIC_0118696596__b68083318184">2019-04-25T20:04:47.591Z</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0118696596__row2192135517140"><td class="cellrowborder" valign="top" width="23.93%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0118696596__p1201928510290">end_time</p>
</td>
<td class="cellrowborder" valign="top" width="23.75%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0118696596__p3403799810290">String</p>
</td>
<td class="cellrowborder" valign="top" width="52.32%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="EN-US_TOPIC_0118696596__p5052973810290">Specifies the time when the job ended.</p>
<p id="EN-US_TOPIC_0118696596__p970018924217">The timestamp format is ISO 8601, for example, <strong id="EN-US_TOPIC_0118696596__b142488618186">2019-04-26T20:04:47.591Z</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0118696596__row5463148917140"><td class="cellrowborder" valign="top" width="23.93%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0118696596__p6052212310290">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="23.75%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0118696596__p334495010290">String</p>
</td>
<td class="cellrowborder" valign="top" width="52.32%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="EN-US_TOPIC_0118696596__p2254991410290">Specifies the error code returned upon a task execution failure.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0118696596__row6572248917140"><td class="cellrowborder" valign="top" width="23.93%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0118696596__p6432481010290">fail_reason</p>
</td>
<td class="cellrowborder" valign="top" width="23.75%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0118696596__p4292711110290">String</p>
</td>
<td class="cellrowborder" valign="top" width="52.32%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="EN-US_TOPIC_0118696596__p2113349010290">Specifies the cause of a task execution failure.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0118696596__row5949828117140"><td class="cellrowborder" valign="top" width="23.93%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0118696596__p3838440010290">message</p>
</td>
<td class="cellrowborder" valign="top" width="23.75%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0118696596__p2212873510290">String</p>
</td>
<td class="cellrowborder" valign="top" width="52.32%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="EN-US_TOPIC_0118696596__p2572110510290">Specifies the message returned when an error occurs.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0118696596__row5135016217140"><td class="cellrowborder" valign="top" width="23.93%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0118696596__p2731299110290">code</p>
</td>
<td class="cellrowborder" valign="top" width="23.75%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0118696596__p6486867210290">String</p>
</td>
<td class="cellrowborder" valign="top" width="52.32%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="EN-US_TOPIC_0118696596__p4462200910290">Specifies the error code returned when an error occurs.</p>
<p id="EN-US_TOPIC_0118696596__p6605376310290">For details about error codes, see section <a href="en-us_topic_0053158690.html">Status Codes</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0118696596__table2577901102930"></a><a name="table2577901102930"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0118696596__table2577901102930" frame="border" border="1" rules="all"><caption><b>Table 4 </b><strong id="EN-US_TOPIC_0118696596__b970021174010">entities</strong> field data structure description</caption><thead align="left"><tr id="EN-US_TOPIC_0118696596__row41961594102930"><th align="left" class="cellrowborder" valign="top" width="23.47%" id="mcps1.3.4.2.1.4.2.4.1.1"><p id="EN-US_TOPIC_0118696596__p14673171924310">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="24.3%" id="mcps1.3.4.2.1.4.2.4.1.2"><p id="EN-US_TOPIC_0118696596__p1767515196438">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="52.23%" id="mcps1.3.4.2.1.4.2.4.1.3"><p id="EN-US_TOPIC_0118696596__p1967812199432">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0118696596__row12623506102930"><td class="cellrowborder" valign="top" width="23.47%" headers="mcps1.3.4.2.1.4.2.4.1.1 "><p id="EN-US_TOPIC_0118696596__p15871098102930">server_id</p>
</td>
<td class="cellrowborder" valign="top" width="24.3%" headers="mcps1.3.4.2.1.4.2.4.1.2 "><p id="EN-US_TOPIC_0118696596__p10490546102930">String</p>
</td>
<td class="cellrowborder" valign="top" width="52.23%" headers="mcps1.3.4.2.1.4.2.4.1.3 "><p id="EN-US_TOPIC_0118696596__p64306551102930">If the task is a <span id="EN-US_TOPIC_0118696596__text4200019145516">BMS</span><span id="EN-US_TOPIC_0118696596__text0200141925511"></span>-related operation, <strong id="EN-US_TOPIC_0118696596__b47485573523">server_id</strong> is displayed.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0118696596__row41888051102930"><td class="cellrowborder" valign="top" width="23.47%" headers="mcps1.3.4.2.1.4.2.4.1.1 "><p id="EN-US_TOPIC_0118696596__p37488972102930">nic_id</p>
</td>
<td class="cellrowborder" valign="top" width="24.3%" headers="mcps1.3.4.2.1.4.2.4.1.2 "><p id="EN-US_TOPIC_0118696596__p16707926102930">String</p>
</td>
<td class="cellrowborder" valign="top" width="52.23%" headers="mcps1.3.4.2.1.4.2.4.1.3 "><p id="EN-US_TOPIC_0118696596__p33374275102930">If the task is a NIC-related operation, the value is <strong id="EN-US_TOPIC_0118696596__b65546242155433">nic_id</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0118696596__li135629453819">Example response<div class="codecoloring" codetype="Java" id="EN-US_TOPIC_0118696596__screen3451280204146"><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>
<span class="normal">14</span>
<span class="normal">15</span>
<span class="normal">16</span>
<span class="normal">17</span>
<span class="normal">18</span>
<span class="normal">19</span>
<span class="normal">20</span>
<span class="normal">21</span>
<span class="normal">22</span>
<span class="normal">23</span>
<span class="normal">24</span>
<span class="normal">25</span>
<span class="normal">26</span></pre></div></td><td class="code"><div><pre><span></span><span class="p">{</span>
<span class="w"> </span><span class="s">&quot;status&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;SUCCESS&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;entities&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="s">&quot;sub_jobs_total&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;sub_jobs&quot;</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">&quot;status&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;SUCCESS&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;entities&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="s">&quot;server_id&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;bae51750-0089-41a1-9b18-5c777978ff6d&quot;</span>
<span class="w"> </span><span class="p">},</span>
<span class="w"> </span><span class="s">&quot;job_id&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;2c9eb2c5544cbf6101544f0635672b60&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;job_type&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;baremetalSingleCreate&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;begin_time&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;2019-04-25T20:04:47.591Z&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;end_time&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;2019-04-25T20:08:21.328Z&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;error_code&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;fail_reason&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">null</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="w"> </span><span class="s">&quot;job_id&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;2c9eb2c5544cbf6101544f0602af2b4f&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;job_type&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;baremetalBatchCreate&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;begin_time&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;2019-04-25T20:04:34.604Z&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;end_time&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;2019-04-25T20:08:41.593Z&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;error_code&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;fail_reason&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span>
<span class="p">}</span>
</pre></div></td></tr></table></div>
</div>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0118696596__section7610951"><h4 class="sectiontitle">Returned Values</h4><div class="p" id="EN-US_TOPIC_0118696596__en-us_topic_0106040941_p193201622141412">Normal values
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0118696596__en-us_topic_0106040941_table753804619176" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0118696596__en-us_topic_0106040941_row10735134615172"><th align="left" class="cellrowborder" valign="top" width="42.42%" id="mcps1.3.5.2.1.1.3.1.1"><p id="EN-US_TOPIC_0118696596__en-us_topic_0106040941_p19735204616177">Returned Values</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="57.58%" id="mcps1.3.5.2.1.1.3.1.2"><p id="EN-US_TOPIC_0118696596__en-us_topic_0106040941_p207355465176">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0118696596__en-us_topic_0106040941_row1473514621713"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.5.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0118696596__en-us_topic_0106040941_p13735144611178">200</p>
</td>
<td class="cellrowborder" valign="top" width="57.58%" headers="mcps1.3.5.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0118696596__en-us_topic_0106040941_p207351246161711">The request has been successfully processed.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<p id="EN-US_TOPIC_0118696596__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_0118696596__section14752650154917"><h4 class="sectiontitle">Error Codes</h4><p id="EN-US_TOPIC_0118696596__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_0118683801.html">Task Management</a></div>
</div>
</div>
View Git Blame Copy Permalink