forked from docs/doc-exports
zhangyue
f3b09e5d2f
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com> Co-authored-by: zhangyue <zhangyue164@huawei.com> Co-committed-by: zhangyue <zhangyue164@huawei.com>
377 lines
28 KiB
HTML
377 lines
28 KiB
HTML
<a name="evs_04_0054"></a><a name="evs_04_0054"></a>
|
|
|
|
<h1 class="topictitle1">Querying Task Status</h1>
|
|
<div id="body39756633"><div class="section" id="evs_04_0054__section48616240"><h4 class="sectiontitle">Function</h4><p id="evs_04_0054__p66170694">This API is used to query the execution status of tasks, such as the status of disk creation, capacity expansion, and deletion.</p>
|
|
</div>
|
|
<div class="section" id="evs_04_0054__section34892981"><h4 class="sectiontitle">URI</h4><ul id="evs_04_0054__ul58225979"><li id="evs_04_0054__li54271769">URI format<p id="evs_04_0054__p33937134"><a name="evs_04_0054__li54271769"></a><a name="li54271769"></a>GET /v1/{project_id}/jobs/{job_id}</p>
|
|
</li><li id="evs_04_0054__li36998751">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_0054__table64553311" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_0054__row24013807"><th align="left" class="cellrowborder" valign="top" width="33.33%" id="mcps1.3.2.2.2.1.1.4.1.1"><p id="evs_04_0054__p66070243">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="19.05%" id="mcps1.3.2.2.2.1.1.4.1.2"><p id="evs_04_0054__p50089467">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="47.620000000000005%" id="mcps1.3.2.2.2.1.1.4.1.3"><p id="evs_04_0054__p188321746194612">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="evs_04_0054__row4890297"><td class="cellrowborder" valign="top" width="33.33%" headers="mcps1.3.2.2.2.1.1.4.1.1 "><p id="evs_04_0054__p60569775">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.05%" headers="mcps1.3.2.2.2.1.1.4.1.2 "><p id="evs_04_0054__p7204713">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="47.620000000000005%" headers="mcps1.3.2.2.2.1.1.4.1.3 "><p id="evs_04_0054__p46710863">Specifies the project ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="evs_04_0054__row17744591"><td class="cellrowborder" valign="top" width="33.33%" headers="mcps1.3.2.2.2.1.1.4.1.1 "><p id="evs_04_0054__p28025763">job_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.05%" headers="mcps1.3.2.2.2.1.1.4.1.2 "><p id="evs_04_0054__p55494360">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="47.620000000000005%" headers="mcps1.3.2.2.2.1.1.4.1.3 "><p id="evs_04_0054__p65858198">Specifies the task ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="evs_04_0054__section45601378"><h4 class="sectiontitle">Request</h4><p id="evs_04_0054__p34907712467">The following example shows how to query the status of the task whose task ID is ff808081692a62c70169b4dcf9514264.</p>
|
|
<ul id="evs_04_0054__ul1486625144210"><li id="evs_04_0054__li15867175110427">Example request<pre class="screen" id="evs_04_0054__screen20698155124214"> GET https://{endpoint}/v1/{project_id}/jobs/ff808081692a62c70169b4dcf9514264</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="evs_04_0054__section7759225"><h4 class="sectiontitle">Response</h4><ul id="evs_04_0054__ul48771786"><li id="evs_04_0054__li65222367201921">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_0054__table50130391201921" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_0054__row66097272201921"><th align="left" class="cellrowborder" valign="top" width="20.48%" id="mcps1.3.4.2.1.1.1.4.1.1"><p id="evs_04_0054__p52278782201921">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="21.69%" id="mcps1.3.4.2.1.1.1.4.1.2"><p id="evs_04_0054__p2711067815824">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="57.830000000000005%" id="mcps1.3.4.2.1.1.1.4.1.3"><p id="evs_04_0054__p7687988201921">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="evs_04_0054__row18747316201921"><td class="cellrowborder" valign="top" width="20.48%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="evs_04_0054__p42137645201921">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.69%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="evs_04_0054__p4848132715824">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.830000000000005%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="evs_04_0054__p4804017891027">Specifies the task status.</p>
|
|
<ul id="evs_04_0054__ul2970842091027"><li id="evs_04_0054__li6604919591027"><strong>SUCCESS</strong>: The task is successfully executed.</li><li id="evs_04_0054__li5757184791027"><strong>RUNNING</strong>: The task is in progress.</li><li id="evs_04_0054__li4838457791027"><strong>FAIL</strong>: The task fails.</li><li id="evs_04_0054__li3280801091027"><strong>INIT</strong>: The task is being initialized.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="evs_04_0054__row57564514201921"><td class="cellrowborder" valign="top" width="20.48%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="evs_04_0054__p32214083201921">entities</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.69%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="evs_04_0054__p3467338415824">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.830000000000005%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="evs_04_0054__p1736414177101">Specifies the response to the task. For details, see <a href="#evs_04_0054__li134182540818">•Parameters in the entities field</a>.</p>
|
|
<p id="evs_04_0054__p30792195201921">The content for each type of task is different.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="evs_04_0054__row8694306201921"><td class="cellrowborder" valign="top" width="20.48%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="evs_04_0054__p33150149201921">job_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.69%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="evs_04_0054__p5708068115824">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.830000000000005%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="evs_04_0054__p65414495201921">Specifies the task ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="evs_04_0054__row51859545201921"><td class="cellrowborder" valign="top" width="20.48%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="evs_04_0054__p39873610201921">job_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.69%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="evs_04_0054__p6013244315824">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.830000000000005%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="evs_04_0054__p20403760201921">Specifies the task type.</p>
|
|
<ul id="evs_04_0054__ul15245145655114"><li id="evs_04_0054__li18247356195117"><strong id="evs_04_0054__b842352706203022">createVolume</strong>: creates a disk.</li><li id="evs_04_0054__li192516561510"><strong id="evs_04_0054__b842352706203040">batchCreateVolume</strong>: batch creates disks.</li><li id="evs_04_0054__li625435675111"><strong id="evs_04_0054__b842352706203121">deleteVolume</strong>: deletes a disk.</li><li id="evs_04_0054__li1525845665117"><strong id="evs_04_0054__b842352706203137">extendVolume</strong>: expands the disk capacity.</li><li id="evs_04_0054__li72862017521"><strong id="evs_04_0054__b84235270620324">bulkDeleteVolume</strong>: batch deletes disks.</li><li id="evs_04_0054__li69181637202718"><strong id="evs_04_0054__b842352706203238">deleteSingleVolume</strong>: deletes disks one by one during a batch deletion.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="evs_04_0054__row49416119201921"><td class="cellrowborder" valign="top" width="20.48%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="evs_04_0054__p43282735201921">begin_time</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.69%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="evs_04_0054__p3888970115824">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.830000000000005%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="evs_04_0054__p40422711201921">Specifies the time when the task was started.</p>
|
|
<p id="evs_04_0054__p221831420710">Time format: YYYY-MM-DDTHH:MM:SS.SSS'Z'</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="evs_04_0054__row28260084201921"><td class="cellrowborder" valign="top" width="20.48%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="evs_04_0054__p7365468201921">end_time</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.69%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="evs_04_0054__p6305809615824">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.830000000000005%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="evs_04_0054__p6457786201921">Specifies the time when the task finished.</p>
|
|
<p id="evs_04_0054__p5536657812">Time format: YYYY-MM-DDTHH:MM:SS.SSS'Z'</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="evs_04_0054__row58120078201921"><td class="cellrowborder" valign="top" width="20.48%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="evs_04_0054__p10105857201921">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.69%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="evs_04_0054__p743216415824">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.830000000000005%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="evs_04_0054__p971080201921">Specifies the returned error code when the task execution fails.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="evs_04_0054__row8739724201921"><td class="cellrowborder" valign="top" width="20.48%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="evs_04_0054__p36829011201921">fail_reason</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.69%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="evs_04_0054__p6513437515824">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.830000000000005%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="evs_04_0054__p43235704201921">Specifies the cause of the task execution failure.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="evs_04_0054__row208351118145015"><td class="cellrowborder" valign="top" width="20.48%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="evs_04_0054__p129522216412">error</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.69%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="evs_04_0054__evs_04_2010_p1595262111415">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.830000000000005%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="evs_04_0054__p109527215417">Specifies the error message returned when an error occurs. For details, see <a href="#evs_04_0054__li0419202382514">Parameters in the error field</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="evs_04_0054__li134182540818"><a name="evs_04_0054__li134182540818"></a><a name="li134182540818"></a>Parameter in the <strong id="evs_04_0054__b842352706152837">entities</strong> field
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_0054__table165761957483" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_0054__row1957611571285"><th align="left" class="cellrowborder" valign="top" width="20.23202320232023%" id="mcps1.3.4.2.2.2.1.4.1.1"><p id="evs_04_0054__p1276131916910">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="21.972197219721973%" id="mcps1.3.4.2.2.2.1.4.1.2"><p id="evs_04_0054__p14276101916912">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="57.795779577957795%" id="mcps1.3.4.2.2.2.1.4.1.3"><p id="evs_04_0054__p627610191596">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="evs_04_0054__row1028619115326"><td class="cellrowborder" valign="top" width="20.23202320232023%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_0054__p1128616115329">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.972197219721973%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_0054__p2028661116321">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.795779577957795%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_0054__p8720124117328">Specifies the EVS disk name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="evs_04_0054__row37149393213"><td class="cellrowborder" valign="top" width="20.23202320232023%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_0054__p97140353219">size</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.972197219721973%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_0054__p97141633323">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.795779577957795%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_0054__p12714031327">Specifies the disk size, in GB.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="evs_04_0054__row135768571586"><td class="cellrowborder" valign="top" width="20.23202320232023%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_0054__p239893649137">sub_jobs</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.972197219721973%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_0054__p640903559137">Array of Objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.795779577957795%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_0054__p597890789137">Specifies the information about a sub-job. For details, see <a href="#evs_04_0054__li1622214314366">•Parameters in the sub_jobs field</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="evs_04_0054__row7775144323420"><td class="cellrowborder" valign="top" width="20.23202320232023%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_0054__p37754438347">volume_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.972197219721973%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_0054__p17346191720356">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.795779577957795%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_0054__p477534323411">Specifies the disk ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="evs_04_0054__row178791646153418"><td class="cellrowborder" valign="top" width="20.23202320232023%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_0054__p1226219733512">volume_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.972197219721973%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_0054__p13158151817356">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.795779577957795%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_0054__p18794465347">Specifies the disk type.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="evs_04_0054__li1622214314366"><a name="evs_04_0054__li1622214314366"></a><a name="li1622214314366"></a>Parameters in the <strong id="evs_04_0054__b767842723717">sub_jobs</strong> field
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_0054__table6865512113719" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_0054__row297153474016"><th align="left" class="cellrowborder" valign="top" width="20.65%" id="mcps1.3.4.2.3.2.1.4.1.1"><p id="evs_04_0054__p1797113341404"><strong id="evs_04_0054__b339473215412">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="21.52%" id="mcps1.3.4.2.3.2.1.4.1.2"><p id="evs_04_0054__p49711134164013">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="57.830000000000005%" id="mcps1.3.4.2.3.2.1.4.1.3"><p id="evs_04_0054__p15971834164010">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="evs_04_0054__row189771734174015"><td class="cellrowborder" valign="top" width="20.65%" headers="mcps1.3.4.2.3.2.1.4.1.1 "><p id="evs_04_0054__p1397633444016">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.52%" headers="mcps1.3.4.2.3.2.1.4.1.2 "><p id="evs_04_0054__p297653410404">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.830000000000005%" headers="mcps1.3.4.2.3.2.1.4.1.3 "><p id="evs_04_0054__p1397683416404">Specifies the task status.</p>
|
|
<ul id="evs_04_0054__ul29772349401"><li id="evs_04_0054__li16977103415408"><strong>SUCCESS</strong>: The task is successfully executed.</li><li id="evs_04_0054__li1197783410407"><strong>RUNNING</strong>: The task is in progress.</li><li id="evs_04_0054__li1297733474017"><strong>FAIL</strong>: The task fails.</li><li id="evs_04_0054__li1497703418406"><strong>INIT</strong>: The task is being initialized.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="evs_04_0054__row119772034184010"><td class="cellrowborder" valign="top" width="20.65%" headers="mcps1.3.4.2.3.2.1.4.1.1 "><p id="evs_04_0054__p8977113424018">entities</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.52%" headers="mcps1.3.4.2.3.2.1.4.1.2 "><p id="evs_04_0054__p179771343406">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.830000000000005%" headers="mcps1.3.4.2.3.2.1.4.1.3 "><p id="evs_04_0054__p1977334104014">Specifies the response to the task. For details, see <a href="#evs_04_0054__li7735129144218">•Parameters in the entities field</a>.</p>
|
|
<p id="evs_04_0054__p897715340404">The content for each type of task is different.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="evs_04_0054__row1197793494011"><td class="cellrowborder" valign="top" width="20.65%" headers="mcps1.3.4.2.3.2.1.4.1.1 "><p id="evs_04_0054__p19977173415408">job_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.52%" headers="mcps1.3.4.2.3.2.1.4.1.2 "><p id="evs_04_0054__p129776340403">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.830000000000005%" headers="mcps1.3.4.2.3.2.1.4.1.3 "><p id="evs_04_0054__p2977133424012">Specifies the task ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="evs_04_0054__row19977203420405"><td class="cellrowborder" valign="top" width="20.65%" headers="mcps1.3.4.2.3.2.1.4.1.1 "><p id="evs_04_0054__p29771134164010">job_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.52%" headers="mcps1.3.4.2.3.2.1.4.1.2 "><p id="evs_04_0054__p097763417405">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.830000000000005%" headers="mcps1.3.4.2.3.2.1.4.1.3 "><p id="evs_04_0054__p8977143419406">Specifies the task type.</p>
|
|
<ul id="evs_04_0054__ul1697753474012"><li id="evs_04_0054__li109779344405"><strong id="evs_04_0054__b1624394636">createVolume</strong>: creates a disk.</li><li id="evs_04_0054__li1697733414400"><strong id="evs_04_0054__b610761283">batchCreateVolume</strong>: batch creates disks.</li><li id="evs_04_0054__li1397713410408"><strong id="evs_04_0054__b1315942888">deleteVolume</strong>: deletes a disk.</li><li id="evs_04_0054__li597713494010"><strong id="evs_04_0054__b198021909">extendVolume</strong>: expands the disk capacity.</li><li id="evs_04_0054__li497783415401"><strong id="evs_04_0054__b2031746236">bulkDeleteVolume</strong>: batch deletes disks.</li><li id="evs_04_0054__li0977113410406"><strong id="evs_04_0054__b1003807770">deleteSingleVolume</strong>: deletes disks one by one during a batch deletion.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="evs_04_0054__row18977123413409"><td class="cellrowborder" valign="top" width="20.65%" headers="mcps1.3.4.2.3.2.1.4.1.1 "><p id="evs_04_0054__p8977123420406">begin_time</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.52%" headers="mcps1.3.4.2.3.2.1.4.1.2 "><p id="evs_04_0054__p79771234134018">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.830000000000005%" headers="mcps1.3.4.2.3.2.1.4.1.3 "><p id="evs_04_0054__p1697783424017">Specifies the time when the task was started.</p>
|
|
<p id="evs_04_0054__p79771134174010">Time format: YYYY-MM-DDTHH:MM:SS.SSS'Z'</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="evs_04_0054__row1697723410405"><td class="cellrowborder" valign="top" width="20.65%" headers="mcps1.3.4.2.3.2.1.4.1.1 "><p id="evs_04_0054__p997714340402">end_time</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.52%" headers="mcps1.3.4.2.3.2.1.4.1.2 "><p id="evs_04_0054__p1977113412405">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.830000000000005%" headers="mcps1.3.4.2.3.2.1.4.1.3 "><p id="evs_04_0054__p597733416409">Specifies the time when the task finished.</p>
|
|
<p id="evs_04_0054__p189771634164018">Time format: YYYY-MM-DDTHH:MM:SS.SSS'Z'</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="evs_04_0054__row16977133416400"><td class="cellrowborder" valign="top" width="20.65%" headers="mcps1.3.4.2.3.2.1.4.1.1 "><p id="evs_04_0054__p189771034134013">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.52%" headers="mcps1.3.4.2.3.2.1.4.1.2 "><p id="evs_04_0054__p597712347401">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.830000000000005%" headers="mcps1.3.4.2.3.2.1.4.1.3 "><p id="evs_04_0054__p1797793412407">Specifies the returned error code when the task execution fails.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="evs_04_0054__row69780343405"><td class="cellrowborder" valign="top" width="20.65%" headers="mcps1.3.4.2.3.2.1.4.1.1 "><p id="evs_04_0054__p19977834204015">fail_reason</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.52%" headers="mcps1.3.4.2.3.2.1.4.1.2 "><p id="evs_04_0054__p8977153411401">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.830000000000005%" headers="mcps1.3.4.2.3.2.1.4.1.3 "><p id="evs_04_0054__p69787349406">Specifies the cause of the task execution failure.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="evs_04_0054__li7735129144218"><a name="evs_04_0054__li7735129144218"></a><a name="li7735129144218"></a>Parameter in the <strong id="evs_04_0054__b111961021194213">entities</strong> field
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_0054__table20171524315" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_0054__row01615124316"><th align="left" class="cellrowborder" valign="top" width="20.652065206520653%" id="mcps1.3.4.2.4.2.1.4.1.1"><p id="evs_04_0054__p37001534154314">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="21.832183218321834%" id="mcps1.3.4.2.4.2.1.4.1.2"><p id="evs_04_0054__p1470023413436">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="57.515751575157516%" id="mcps1.3.4.2.4.2.1.4.1.3"><p id="evs_04_0054__p2700834134312"><strong id="evs_04_0054__b122917234424">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="evs_04_0054__row11315194319"><td class="cellrowborder" valign="top" width="20.652065206520653%" headers="mcps1.3.4.2.4.2.1.4.1.1 "><p id="evs_04_0054__p18700934114318">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.832183218321834%" headers="mcps1.3.4.2.4.2.1.4.1.2 "><p id="evs_04_0054__p6700334194318">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.515751575157516%" headers="mcps1.3.4.2.4.2.1.4.1.3 "><p id="evs_04_0054__p570013424318">Specifies the EVS disk name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="evs_04_0054__row7111157438"><td class="cellrowborder" valign="top" width="20.652065206520653%" headers="mcps1.3.4.2.4.2.1.4.1.1 "><p id="evs_04_0054__p1700193484314">size</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.832183218321834%" headers="mcps1.3.4.2.4.2.1.4.1.2 "><p id="evs_04_0054__p97001834114319">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.515751575157516%" headers="mcps1.3.4.2.4.2.1.4.1.3 "><p id="evs_04_0054__p12700163444315">Specifies the disk size, in GB.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="evs_04_0054__row4110151438"><td class="cellrowborder" valign="top" width="20.652065206520653%" headers="mcps1.3.4.2.4.2.1.4.1.1 "><p id="evs_04_0054__p1823415517435">volume_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.832183218321834%" headers="mcps1.3.4.2.4.2.1.4.1.2 "><p id="evs_04_0054__p023445194310">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.515751575157516%" headers="mcps1.3.4.2.4.2.1.4.1.3 "><p id="evs_04_0054__p20234145114311">Specifies the disk ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="evs_04_0054__row181161513436"><td class="cellrowborder" valign="top" width="20.652065206520653%" headers="mcps1.3.4.2.4.2.1.4.1.1 "><p id="evs_04_0054__p192341751164316">volume_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.832183218321834%" headers="mcps1.3.4.2.4.2.1.4.1.2 "><p id="evs_04_0054__p1123565124315">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.515751575157516%" headers="mcps1.3.4.2.4.2.1.4.1.3 "><p id="evs_04_0054__p16235115154318">Specifies the disk type.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="evs_04_0054__li0419202382514"><a name="evs_04_0054__li0419202382514"></a><a name="li0419202382514"></a>Parameters in the <strong id="evs_04_0054__evs_04_2013_b1288034833610">error</strong> field
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_0054__evs_04_2013_table15441099103019" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_0054__evs_04_2013_row54094047103019"><th align="left" class="cellrowborder" valign="top" width="21.17788221177882%" id="mcps1.3.4.2.5.2.1.4.1.1"><p id="evs_04_0054__evs_04_2013_p19541716103019">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="21.17788221177882%" id="mcps1.3.4.2.5.2.1.4.1.2"><p id="evs_04_0054__evs_04_2013_p39375186103019">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="57.64423557644236%" id="mcps1.3.4.2.5.2.1.4.1.3"><p id="evs_04_0054__evs_04_2013_p38578950103019">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="evs_04_0054__evs_04_2013_row59401790103019"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.5.2.1.4.1.1 "><p id="evs_04_0054__evs_04_2013_p46815658103019">message</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.5.2.1.4.1.2 "><p id="evs_04_0054__evs_04_2013_p33971979103019">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.64423557644236%" headers="mcps1.3.4.2.5.2.1.4.1.3 "><p id="evs_04_0054__evs_04_2013_p21623243103019">The error message returned if an error occurs.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="evs_04_0054__evs_04_2013_row60391466103019"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.5.2.1.4.1.1 "><p id="evs_04_0054__evs_04_2013_p59870541103019">code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.5.2.1.4.1.2 "><p id="evs_04_0054__evs_04_2013_p17675690103019">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.64423557644236%" headers="mcps1.3.4.2.5.2.1.4.1.3 "><p id="evs_04_0054__evs_04_2013_p6087468103019">The error code returned if an error occurs.</p>
|
|
<p id="evs_04_0054__evs_04_2013_p54787218103019">For details about the error code, see <a href="evs_04_0038.html">Error Codes</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="evs_04_0054__li36292894">Example response<pre class="screen" id="evs_04_0054__screen589316311992">{
|
|
"status": "RUNNING",
|
|
"entities": {
|
|
"volume_id": "bdf1bb37-f20f-4266-9a04-f43e0a127376"
|
|
},
|
|
"job_id": "4010a32d535527910153552b492c0002",
|
|
"job_type": "createVolume",
|
|
"begin_time": "2016-03-08T07:40:13.219Z",
|
|
"end_time": "",
|
|
"error_code": null,
|
|
"fail_reason": null
|
|
}</pre>
|
|
<p id="evs_04_0054__p1589612315915">or</p>
|
|
<pre class="screen" id="evs_04_0054__screen20542852493">{
|
|
"status": "SUCCESS",
|
|
"entities": {
|
|
"sub_jobs": [
|
|
{
|
|
"status": "SUCCESS",
|
|
"entities": {
|
|
"volume_id": "0b549095-4937-4849-8e4c-52aa027d64f7"
|
|
},
|
|
"job_id": "21917a8d52a19b040152a9f2f2e50041",
|
|
"job_type": "createVolume",
|
|
"begin_time": "2016-02-04T01:43:37.445Z",
|
|
"end_time": "2016-02-04T01:44:02.239Z",
|
|
"error_code": null,
|
|
"fail_reason": null
|
|
},
|
|
{
|
|
"status": "SUCCESS",
|
|
"entities": {
|
|
"volume_id": "e7bca1a2-d3ed-434f-86f4-a1f11aa80072"
|
|
},
|
|
"job_id": "21917a8d52a19b040152a9f2f2f60042",
|
|
"job_type": "createVolume",
|
|
"begin_time": "2016-02-04T01:43:37.462Z",
|
|
"end_time": "2016-02-04T01:44:02.245Z",
|
|
"error_code": null,
|
|
"fail_reason": null
|
|
}
|
|
]
|
|
},
|
|
"job_id": "21917a8d52a19b040152a9f2f1eb003e",
|
|
"job_type": "batchCreateVolume",
|
|
"begin_time": "2016-02-04T01:43:37.193Z",
|
|
"end_time": "2016-02-04T01:44:08.283Z",
|
|
"error_code": null,
|
|
"fail_reason": null
|
|
}</pre>
|
|
<p id="evs_04_0054__p118421547697">or</p>
|
|
<pre class="screen" id="evs_04_0054__screen789653115918">{
|
|
"error": {
|
|
"message": "XXXX",
|
|
"code": "XXX"
|
|
}
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="evs_04_0054__section2724161"><h4 class="sectiontitle">Status Codes</h4><ul id="evs_04_0054__ul26952341"><li id="evs_04_0054__li41244482">Normal<p id="evs_04_0054__p35656026"><a name="evs_04_0054__li41244482"></a><a name="li41244482"></a>200</p>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="evs_04_0054__section431317151242"><h4 class="sectiontitle">Error Codes</h4><p id="evs_04_0054__evs_04_2013_p783819215242">For details, see <a href="evs_04_0038.html">Error Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="evs_04_0053.html">API v1</a></div>
|
|
</div>
|
|
</div>
|
|
|