forked from docs/doc-exports
Su, Xiaomeng
2374069890
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>
119 lines
9.3 KiB
HTML
119 lines
9.3 KiB
HTML
<a name="dli_02_0104"></a><a name="dli_02_0104"></a>
|
|
|
|
<h1 class="topictitle1">Canceling a Job (Recommended)</h1>
|
|
<div id="body1516173559148"><div class="section" id="dli_02_0104__s15d8cb8e7b7f4b47acbc825ca34ae180"><h4 class="sectiontitle">Function</h4><p id="dli_02_0104__en-us_topic_0069077896_p5462210">This API is used to cancel a submitted job. If execution of a job completes or fails, this job cannot be canceled.</p>
|
|
</div>
|
|
<div class="section" id="dli_02_0104__sec7331dc70ce415da2d94a4062c0e286"><h4 class="sectiontitle">URI</h4><ul id="dli_02_0104__en-us_topic_0069077896_ul39785843"><li id="dli_02_0104__en-us_topic_0069077896_li22528274">URI format<p id="dli_02_0104__p15298970102817"><a name="dli_02_0104__en-us_topic_0069077896_li22528274"></a><a name="en-us_topic_0069077896_li22528274"></a>DELETE /v1.0/{project_id}/jobs/{job_id}</p>
|
|
</li><li id="dli_02_0104__li983216201242">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0104__en-us_topic_0069077896_table12850938" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameters</caption><thead align="left"><tr id="dli_02_0104__en-us_topic_0069077896_row26986831"><th align="left" class="cellrowborder" valign="top" width="12.971297129712973%" id="mcps1.3.2.2.2.1.2.5.1.1"><p id="dli_02_0104__ac4350eeb47b04ac3842d18c867bd44eb">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="11.14111411141114%" id="mcps1.3.2.2.2.1.2.5.1.2"><p id="dli_02_0104__a9c7aa8e702fe45d598376fcd31c9f5ce">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="12.84128412841284%" id="mcps1.3.2.2.2.1.2.5.1.3"><p id="dli_02_0104__p1585311325917">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="63.04630463046305%" id="mcps1.3.2.2.2.1.2.5.1.4"><p id="dli_02_0104__a319b72a499674bd8befd20b6a9358879">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dli_02_0104__row134331617104113"><td class="cellrowborder" valign="top" width="12.971297129712973%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="dli_02_0104__en-us_topic_0069077803_p43412436">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.14111411141114%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="dli_02_0104__en-us_topic_0069077803_p26746391">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.84128412841284%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="dli_02_0104__p98535365912">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63.04630463046305%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="dli_02_0104__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_0104__en-us_topic_0069077896_row56271154"><td class="cellrowborder" valign="top" width="12.971297129712973%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="dli_02_0104__en-us_topic_0069077896_p61669616">job_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.14111411141114%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="dli_02_0104__en-us_topic_0069077896_p29183003">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.84128412841284%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="dli_02_0104__p2085315311599">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63.04630463046305%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="dli_02_0104__p861213494479">Job ID. You can get the value by calling <a href="dli_02_0102.html">Submitting a SQL Job (Recommended)</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="dli_02_0104__sf71ef29ac20f4a86b617e33b97566e44"><h4 class="sectiontitle">Request</h4><p id="dli_02_0104__p59124830151154">None</p>
|
|
</div>
|
|
<div class="section" id="dli_02_0104__s3cacdc89985c49fa9b00c879e3880d15"><h4 class="sectiontitle">Response</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0104__en-us_topic_0069077896_table33203075" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response parameters</caption><thead align="left"><tr id="dli_02_0104__en-us_topic_0069077896_row35922485"><th align="left" class="cellrowborder" valign="top" width="12.379999999999999%" id="mcps1.3.4.2.2.5.1.1"><p id="dli_02_0104__a5212f67c295f4ae7a136c5eb4d263e47">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="10.71%" id="mcps1.3.4.2.2.5.1.2"><p id="dli_02_0104__p1386520233613">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="9.43%" id="mcps1.3.4.2.2.5.1.3"><p id="dli_02_0104__en-us_topic_0069077896_p944819142913">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="67.47999999999999%" id="mcps1.3.4.2.2.5.1.4"><p id="dli_02_0104__en-us_topic_0069077896_p944851413912">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dli_02_0104__en-us_topic_0069077896_row12898672"><td class="cellrowborder" valign="top" width="12.379999999999999%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0104__en-us_topic_0069077896_p38159543">is_success</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.71%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0104__p198651823862">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="9.43%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0104__en-us_topic_0069077896_p48699120">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="67.47999999999999%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0104__p1216075194811">Whether the request is successfully executed. Value <span class="parmvalue" id="dli_02_0104__parmvalue2253974916747"><b>true</b></span> indicates that the request is successfully executed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0104__en-us_topic_0069077896_row1070040"><td class="cellrowborder" valign="top" width="12.379999999999999%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0104__en-us_topic_0069077896_p19564417">message</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.71%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0104__p5865423469">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="9.43%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0104__en-us_topic_0069077896_p49998030">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="67.47999999999999%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0104__a4fa277540d3e42e48cec2027a36ca6bc">System prompt. If execution succeeds, the parameter setting may be left blank.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="dli_02_0104__section1267554313159"><h4 class="sectiontitle">Example Request</h4><p id="dli_02_0104__p16826101012164">None</p>
|
|
</div>
|
|
<div class="section" id="dli_02_0104__section43379838151112"><h4 class="sectiontitle">Example Response</h4><pre class="screen" id="dli_02_0104__screen1998237151132">{
|
|
"is_success": true,
|
|
"message": ""
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="dli_02_0104__sf39cfd445ad24e9e82754fcb0027179d"><h4 class="sectiontitle">Status Codes</h4><p id="dli_02_0104__a04144ca3a08e4576b386c6a98f43a2ae"><a href="#dli_02_0104__tb12870f1c5f24b27abd55ca24264af36">Table 3</a> describes the status code.</p>
|
|
|
|
<div class="tablenoborder"><a name="dli_02_0104__tb12870f1c5f24b27abd55ca24264af36"></a><a name="tb12870f1c5f24b27abd55ca24264af36"></a><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0104__tb12870f1c5f24b27abd55ca24264af36" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Status codes</caption><thead align="left"><tr id="dli_02_0104__r8d54231f95b14c01a5e55e95f3b2e838"><th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.7.3.2.3.1.1"><p id="dli_02_0104__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_0104__aea1d3bd107bb4c499da79a88832d256c">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dli_02_0104__r211ad4eb571d4d938e5579998723174e"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.7.3.2.3.1.1 "><p id="dli_02_0104__a3153e07b3a9749adba92599fe6628fbf">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.7.3.2.3.1.2 "><p id="dli_02_0104__p104431642124811">Canceled.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0104__row44937531727"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.7.3.2.3.1.1 "><p id="dli_02_0104__p184941532219">400</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.7.3.2.3.1.2 "><p id="dli_02_0104__p2049413539219">Request error.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0104__row65331212142411"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.7.3.2.3.1.1 "><p id="dli_02_0104__p5537171216249">500</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.7.3.2.3.1.2 "><p id="dli_02_0104__p953813124249">Internal service error.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="dli_02_0104__section13596141025715"><h4 class="sectiontitle">Error Codes</h4><p id="dli_02_0104__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 Code</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="dli_02_0017.html">Job-related APIs</a></div>
|
|
</div>
|
|
</div>
|
|
|