forked from docs/doc-exports
Su, Xiaomeng
57a0d535be
Reviewed-by: Pruthi, Vineet <vineet.pruthi@t-systems.com> Co-authored-by: Su, Xiaomeng <suxiaomeng1@huawei.com> Co-committed-by: Su, Xiaomeng <suxiaomeng1@huawei.com>
111 lines
9.8 KiB
HTML
111 lines
9.8 KiB
HTML
<a name="dli_02_0129"></a><a name="dli_02_0129"></a>
|
|
|
|
<h1 class="topictitle1">Canceling a Batch Processing Job</h1>
|
|
<div id="body8662426"><div class="section" id="dli_02_0129__en-us_topic_0103345067_en-us_topic_0102902523_s1f0e4fd3d502405199f36f78e68721aa"><h4 class="sectiontitle">Function</h4><p id="dli_02_0129__en-us_topic_0103345067_p50913089163337">This API is used to cancel a batch processing job.</p>
|
|
<div class="note" id="dli_02_0129__note4333131713238"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="dli_02_0129__p933391782316">Batch processing jobs in the <strong id="dli_02_0129__b283742512418">Successful</strong> or <strong id="dli_02_0129__b9838725122418">Failed</strong> state cannot be canceled.</p>
|
|
</div></div>
|
|
</div>
|
|
<div class="section" id="dli_02_0129__en-us_topic_0103345067_en-us_topic_0102902523_s9e1b8ec5b57c422a942b19835da7d66e"><h4 class="sectiontitle">URI</h4><ul id="dli_02_0129__en-us_topic_0103345067_en-us_topic_0102902523_en-us_topic_0069077927_ul10082125"><li id="dli_02_0129__en-us_topic_0103345067_en-us_topic_0102902523_en-us_topic_0069077927_li23630265">URI format<p id="dli_02_0129__en-us_topic_0103345067_p30561133163513"><a name="dli_02_0129__en-us_topic_0103345067_en-us_topic_0102902523_en-us_topic_0069077927_li23630265"></a><a name="en-us_topic_0103345067_en-us_topic_0102902523_en-us_topic_0069077927_li23630265"></a>DELETE /v2.0/{project_id}/batches/{batch_id}</p>
|
|
</li><li id="dli_02_0129__en-us_topic_0103345067_en-us_topic_0102902523_li1725612218454">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0129__en-us_topic_0103345067_en-us_topic_0102902523_en-us_topic_0069077803_table60779388" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameters</caption><thead align="left"><tr id="dli_02_0129__en-us_topic_0103345067_en-us_topic_0102902523_en-us_topic_0069077803_row61411666"><th align="left" class="cellrowborder" valign="top" width="13.700000000000001%" id="mcps1.3.2.2.2.1.2.5.1.1"><p id="dli_02_0129__en-us_topic_0103345067_en-us_topic_0102902523_a420a62a594f9410eaea229ffc8037a61">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="10.54%" id="mcps1.3.2.2.2.1.2.5.1.2"><p id="dli_02_0129__en-us_topic_0103345067_en-us_topic_0102902523_en-us_topic_0069077803_p873025824211">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="12.479999999999999%" id="mcps1.3.2.2.2.1.2.5.1.3"><p id="dli_02_0129__p9211815152616">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="63.28%" id="mcps1.3.2.2.2.1.2.5.1.4"><p id="dli_02_0129__en-us_topic_0103345067_en-us_topic_0102902523_a692d3cd97b464aed90ba6d841900a4a5">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dli_02_0129__en-us_topic_0103345067_en-us_topic_0102902523_en-us_topic_0069077803_row48589216"><td class="cellrowborder" valign="top" width="13.700000000000001%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="dli_02_0129__en-us_topic_0103345067_en-us_topic_0102902523_en-us_topic_0069077803_p43412436">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.54%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="dli_02_0129__en-us_topic_0103345067_en-us_topic_0102902523_en-us_topic_0069077803_p26746391">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.479999999999999%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="dli_02_0129__p32261542617">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63.28%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="dli_02_0129__p1310472724012">Project ID, which is used for resource isolation. For details about how to obtain its value, see <a href="dli_02_0183.html">Obtaining a Project ID</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0129__en-us_topic_0103345067_row40002247161527"><td class="cellrowborder" valign="top" width="13.700000000000001%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="dli_02_0129__en-us_topic_0103345067_p11474470161527">batch_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.54%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="dli_02_0129__en-us_topic_0103345067_p57016873161527">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.479999999999999%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="dli_02_0129__p1422181552611">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63.28%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="dli_02_0129__en-us_topic_0103345067_p54964009161527">ID of a batch processing job. Set the value to the job ID obtained in <a href="dli_02_0124.html">Creating a Batch Processing Job</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="dli_02_0129__en-us_topic_0103345067_en-us_topic_0102902523_section20458182103"><h4 class="sectiontitle">Request</h4><p id="dli_02_0129__en-us_topic_0103345067_p58350097161541">None</p>
|
|
</div>
|
|
<div class="section" id="dli_02_0129__en-us_topic_0103345067_en-us_topic_0102902523_sd1ecb66580054b2ea403be8b2272a2c7"><h4 class="sectiontitle">Response</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0129__en-us_topic_0103345067_en-us_topic_0102902523_table1391425172812" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response parameter</caption><thead align="left"><tr id="dli_02_0129__en-us_topic_0103345067_en-us_topic_0102902523_row239272520282"><th align="left" class="cellrowborder" valign="top" width="15.25%" id="mcps1.3.4.2.2.5.1.1"><p id="dli_02_0129__p28418154407">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20.95%" id="mcps1.3.4.2.2.5.1.2"><p id="dli_02_0129__p041210221192">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="24.759999999999998%" id="mcps1.3.4.2.2.5.1.3"><p id="dli_02_0129__en-us_topic_0103345067_en-us_topic_0102902523_p93931525182819">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="39.04%" id="mcps1.3.4.2.2.5.1.4"><p id="dli_02_0129__en-us_topic_0103345067_en-us_topic_0102902523_p339412542814">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dli_02_0129__en-us_topic_0103345067_row66189892163548"><td class="cellrowborder" valign="top" width="15.25%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0129__en-us_topic_0103345067_p11383590163548">msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.95%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0129__p10413722161918">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="24.759999999999998%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0129__en-us_topic_0103345067_p49655572163548">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.04%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0129__en-us_topic_0103345067_p62678362163548">If the batch processing job is successfully canceled, value <strong id="dli_02_0129__b443412517551">deleted</strong> is returned.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="dli_02_0129__section1217010661112"><h4 class="sectiontitle">Example Request</h4><p id="dli_02_0129__p6101181617111">None</p>
|
|
</div>
|
|
<div class="section" id="dli_02_0129__en-us_topic_0103345067_en-us_topic_0102902523_section17446171164041"><h4 class="sectiontitle">Example Response</h4><pre class="screen" id="dli_02_0129__en-us_topic_0103345067_screen210309163635">{
|
|
"msg": "deleted"
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="dli_02_0129__sf39cfd445ad24e9e82754fcb0027179d"><h4 class="sectiontitle">Status Codes</h4><p id="dli_02_0129__a04144ca3a08e4576b386c6a98f43a2ae"><a href="#dli_02_0129__tb12870f1c5f24b27abd55ca24264af36">Table 3</a> describes the status code.</p>
|
|
|
|
<div class="tablenoborder"><a name="dli_02_0129__tb12870f1c5f24b27abd55ca24264af36"></a><a name="tb12870f1c5f24b27abd55ca24264af36"></a><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0129__tb12870f1c5f24b27abd55ca24264af36" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Status codes</caption><thead align="left"><tr id="dli_02_0129__r8d54231f95b14c01a5e55e95f3b2e838"><th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.7.3.2.3.1.1"><p id="dli_02_0129__ab49d21f312644072a331f43e92baf853">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="70%" id="mcps1.3.7.3.2.3.1.2"><p id="dli_02_0129__aea1d3bd107bb4c499da79a88832d256c">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dli_02_0129__r211ad4eb571d4d938e5579998723174e"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.7.3.2.3.1.1 "><p id="dli_02_0129__a3153e07b3a9749adba92599fe6628fbf">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.7.3.2.3.1.2 "><p id="dli_02_0129__p104431642124811">Deletion succeeded.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0129__row44937531727"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.7.3.2.3.1.1 "><p id="dli_02_0129__p184941532219">400</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.7.3.2.3.1.2 "><p id="dli_02_0129__p2049413539219">Request error.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0129__row65331212142411"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.7.3.2.3.1.1 "><p id="dli_02_0129__p5537171216249">500</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.7.3.2.3.1.2 "><p id="dli_02_0129__p953813124249">Internal service error.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="dli_02_0129__section13596141025715"><h4 class="sectiontitle">Error Codes</h4><p id="dli_02_0129__p420584425712">If an error occurs when this API is invoked, the system does not return the result similar to the preceding example, but returns the error code and error information. For details, see <a href="dli_02_0056.html">Error Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="dli_02_0162.html">Batch Processing-related APIs</a></div>
|
|
</div>
|
|
</div>
|
|
|