forked from docs/doc-exports
Yang, Tong
bd2b57f749
Reviewed-by: gtema <artem.goncharov@gmail.com> Co-authored-by: Yang, Tong <yangtong2@huawei.com> Co-committed-by: Yang, Tong <yangtong2@huawei.com>
231 lines
15 KiB
HTML
231 lines
15 KiB
HTML
<a name="mrs_02_0052"></a><a name="mrs_02_0052"></a>
|
|
|
|
<h1 class="topictitle1">Canceling Job Execution</h1>
|
|
<div id="body1484191679550"><div class="section" id="mrs_02_0052__section5957478711297"><h4 class="sectiontitle">Function</h4><p id="mrs_02_0052__p49124064112911">This API is used to cancel a job object being executed. This API is compatible with Sahara.</p>
|
|
</div>
|
|
<div class="section" id="mrs_02_0052__section9153250112933"><h4 class="sectiontitle">URI</h4><ul id="mrs_02_0052__ul3299804811311"><li id="mrs_02_0052__li3701617811311">Format<p id="mrs_02_0052__p12501438113122"><a name="mrs_02_0052__li3701617811311"></a><a name="li3701617811311"></a>GET /v1.1/{project_id}/job-executions/{job_execution_id}/cancel</p>
|
|
</li><li id="mrs_02_0052__li25932619113111">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="mrs_02_0052__table49499141194754" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameter description</caption><thead align="left"><tr id="mrs_02_0052__row33700024194754"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.2.2.1.2.4.1.1"><p id="mrs_02_0052__p16571835194812">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.2.2.1.2.4.1.2"><p id="mrs_02_0052__p141410194812">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.2.2.2.1.2.4.1.3"><p id="mrs_02_0052__p11454278194812">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="mrs_02_0052__row6505449415356"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.2.2.1.2.4.1.1 "><p id="mrs_02_0052__p3492262515356">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.2.2.1.2.4.1.2 "><p id="mrs_02_0052__p1016041415356">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.2.2.2.1.2.4.1.3 "><p id="mrs_02_0052__p1768719515356">Project ID. For details on how to obtain the project ID, see <a href="mrs_02_0011.html">Obtaining a Project ID</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_0052__row20659256153330"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.2.2.1.2.4.1.1 "><p id="mrs_02_0052__p14068949143358">job_execution_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.2.2.1.2.4.1.2 "><p id="mrs_02_0052__p36449896143358">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.2.2.2.1.2.4.1.3 "><p id="mrs_02_0052__p59095518143358">Job execution object ID</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="mrs_02_0052__section7976792193238"><h4 class="sectiontitle">Request</h4><p id="mrs_02_0052__p1842961591514"><strong id="mrs_02_0052__b139822112354">Request parameters</strong></p>
|
|
<p id="mrs_02_0052__p106160258151">None.</p>
|
|
</div>
|
|
<div class="section" id="mrs_02_0052__section38599577193858"><h4 class="sectiontitle">Response</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="mrs_02_0052__table51257841151049" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response parameter description</caption><thead align="left"><tr id="mrs_02_0052__row8480851151049"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.2.2.4.1.1"><p id="mrs_02_0052__p15860319151049">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.2.2.4.1.2"><p id="mrs_02_0052__p40813771151049">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.2.2.4.1.3"><p id="mrs_02_0052__p17581180151049">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="mrs_02_0052__row6726034151222"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.1 "><p id="mrs_02_0052__p42399257145341">info</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.2 "><p id="mrs_02_0052__p1428203814541">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.2.2.4.1.3 "><p id="mrs_02_0052__p31671624145411">Key-value pair set, containing job running information returned by Oozie</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_0052__row1794513155918"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.1 "><p id="mrs_02_0052__p38981597145341">cluster_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.2 "><p id="mrs_02_0052__p973236414541">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.2.2.4.1.3 "><p id="mrs_02_0052__p3164852145411">Cluster ID</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_0052__row23363161601"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.1 "><p id="mrs_02_0052__p30535368145341">job_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.2 "><p id="mrs_02_0052__p4688460014391">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.2.2.4.1.3 "><p id="mrs_02_0052__p25475938145411">Job ID</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_0052__row52664138135611"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.1 "><p id="mrs_02_0052__p47249950145341">oozie_job_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.2 "><p id="mrs_02_0052__p57515029144652">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.2.2.4.1.3 "><p id="mrs_02_0052__p49912669145411">Workflow ID returned by Oozie</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_0052__row15896716111552"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.1 "><p id="mrs_02_0052__p18366376145341">tenant_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.2 "><p id="mrs_02_0052__p46523794144652">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.2.2.4.1.3 "><p id="mrs_02_0052__p147081301415">Project ID. For details on how to obtain the project ID, see <a href="mrs_02_0011.html">Obtaining a Project ID</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_0052__row14374745135652"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.1 "><p id="mrs_02_0052__p34424442145341">created_at</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.2 "><p id="mrs_02_0052__p43975827144652">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.2.2.4.1.3 "><p id="mrs_02_0052__p55323279145411">Job execution object creation time</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_0052__row26626414135718"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.1 "><p id="mrs_02_0052__p63812528145341">updated_at</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.2 "><p id="mrs_02_0052__p39284672144652">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.2.2.4.1.3 "><p id="mrs_02_0052__p65352516145411">Job execution object update time</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_0052__row12439792135751"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.1 "><p id="mrs_02_0052__p12890412145341">start_time</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.2 "><p id="mrs_02_0052__p50067010144652">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.2.2.4.1.3 "><p id="mrs_02_0052__p61799874145411">Job start time</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_0052__row62845631135831"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.1 "><p id="mrs_02_0052__p60124904145442">end_time</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.2 "><p id="mrs_02_0052__p5570686214391">Bool</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.2.2.4.1.3 "><p id="mrs_02_0052__p27080332145541">Job end time</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_0052__row8652083151249"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.1 "><p id="mrs_02_0052__p8967486145442">return_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.2 "><p id="mrs_02_0052__p4796924214477">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.2.2.4.1.3 "><p id="mrs_02_0052__p11556241145541">Response code after job execution</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_0052__row12228393151256"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.1 "><p id="mrs_02_0052__p27737544145442">input_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.2 "><p id="mrs_02_0052__p2298335114477">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.2.2.4.1.3 "><p id="mrs_02_0052__p35891861145541">Input data source ID of a job execution object</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_0052__row4987054814430"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.1 "><p id="mrs_02_0052__p20901786145442">output_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.2 "><p id="mrs_02_0052__p1786488314430">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.2.2.4.1.3 "><p id="mrs_02_0052__p59818779145541">Output data source ID of a job execution object</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_0052__row2224933814447"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.1 "><p id="mrs_02_0052__p3690448145442">is_protected</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.2 "><p id="mrs_02_0052__p11644244144713">Bool</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.2.2.4.1.3 "><p id="mrs_02_0052__p54237486145541">Whether a job execution object is protected</p>
|
|
<ul id="mrs_02_0052__ul1671978416321"><li id="mrs_02_0052__li1626033516321">true</li><li id="mrs_02_0052__li1212528916321">false</li></ul>
|
|
<p id="mrs_02_0052__p4201874516321">The current version does not support this function.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_0052__row65803519144414"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.1 "><p id="mrs_02_0052__p5982284145442">is_public</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.2 "><p id="mrs_02_0052__p52405738144713">Bool</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.2.2.4.1.3 "><p id="mrs_02_0052__p12006946145541">Whether a job execution object is public</p>
|
|
<ul id="mrs_02_0052__ul3872134516111"><li id="mrs_02_0052__li1294778516111">true</li><li id="mrs_02_0052__li4942120716111">false</li></ul>
|
|
<p id="mrs_02_0052__p4213768316111">The current version does not support this function.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_0052__row42012596144424"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.1 "><p id="mrs_02_0052__p66117752145442">job_configs</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.2 "><p id="mrs_02_0052__p32531313144713">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.2.2.4.1.3 "><p id="mrs_02_0052__p28911440145541">Key-value pair set for saving job running configurations</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_0052__row35356831145431"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.1 "><p id="mrs_02_0052__p15677449145442">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.2 "><p id="mrs_02_0052__p28767711145431">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.2.2.4.1.3 "><p id="mrs_02_0052__p4256989145541">Job execution object ID</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_0052__row62941536101347"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.1 "><p id="mrs_02_0052__p65099693101347">oozie_job_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.2 "><p id="mrs_02_0052__p38277647101347">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.2.2.4.1.3 "><p id="mrs_02_0052__p13481717101347">Workflow ID returned by Oozie</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_0052__row23776573101354"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.1 "><p id="mrs_02_0052__p46854231101354">info</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.2 "><p id="mrs_02_0052__p52014329101354">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.2.2.4.1.3 "><p id="mrs_02_0052__p52411088101354">Key-value pair set, containing job running information returned by Oozie</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="mrs_02_0052__section1210015461189"><h4 class="sectiontitle">Example</h4><ul id="mrs_02_0052__ul1958913536182"><li id="mrs_02_0052__li1558945321814">Example request<p id="mrs_02_0052__p8671133419191"><a name="mrs_02_0052__li1558945321814"></a><a name="li1558945321814"></a>None.</p>
|
|
</li><li id="mrs_02_0052__li543710159193">Example response<pre class="screen" id="mrs_02_0052__screen52912515142830">{
|
|
"job_execution": {
|
|
"created_at": "2017-05-25T07:28:12",
|
|
"updated_at": "2017-05-25T07:28:13",
|
|
"id": "2de74673-1a78-48af-a95b-e1fec4a4ae9c",
|
|
"tenant_id": "37caa80116e1403ab603e5eeb48a2f74",
|
|
"job_id": "",
|
|
"start_time": "2017-05-25T07:28:12",
|
|
"end_time": null,
|
|
"cluster_id": "ef7b54f2-3d92-49b2-a6d7-94607e1ea7df",
|
|
"oozie_job_id": null,
|
|
"return_code": null,
|
|
"input_id": null,
|
|
"output_id": null,
|
|
"is_protected": false,
|
|
"is_public": null,
|
|
"engine_job_id": null,
|
|
"job_configs": null,
|
|
"data_source_urls": null,
|
|
"info": null
|
|
}
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="mrs_02_0052__section25088328113020"><h4 class="sectiontitle">Status Code</h4><p id="mrs_02_0052__p5547365016031"><a href="#mrs_02_0052__table1584477916050">Table 3</a> describes the status code of this API.</p>
|
|
|
|
<div class="tablenoborder"><a name="mrs_02_0052__table1584477916050"></a><a name="table1584477916050"></a><table cellpadding="4" cellspacing="0" summary="" id="mrs_02_0052__table1584477916050" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Status code</caption><thead align="left"><tr id="mrs_02_0052__row1339492016050"><th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.6.3.2.3.1.1"><p id="mrs_02_0052__p3411176516050">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="70%" id="mcps1.3.6.3.2.3.1.2"><p id="mrs_02_0052__p1158961516050">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="mrs_02_0052__row3719767816050"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.6.3.2.3.1.1 "><p id="mrs_02_0052__p6022194016050">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.6.3.2.3.1.2 "><p id="mrs_02_0052__p4613894216050">The job object being executed has been canceled successfully.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="mrs_02_0052__p832755918527">For the description about error status codes, see <a href="mrs_02_0015.html">Status Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="mrs_02_0049.html">Job Execution Object APIs (V1, Not Recommended)</a></div>
|
|
</div>
|
|
</div>
|
|
|