forked from docs/doc-exports
Xiong, Chen Xiao
14a6d65e8c
Reviewed-by: Pruthi, Vineet <vineet.pruthi@t-systems.com> Co-authored-by: Xiong, Chen Xiao <chenxiaoxiong@huawei.com> Co-committed-by: Xiong, Chen Xiao <chenxiaoxiong@huawei.com>
95 lines
9.6 KiB
HTML
95 lines
9.6 KiB
HTML
<a name="dataartsstudio_02_0066"></a><a name="dataartsstudio_02_0066"></a>
|
|
|
|
<h1 class="topictitle1">Stopping a Job Instance</h1>
|
|
<div id="body0000001104654660"><div class="section" id="dataartsstudio_02_0066__en-us_topic_0181281344_section1738101810182"><h4 class="sectiontitle">Function</h4><p id="dataartsstudio_02_0066__en-us_topic_0181281344_p1912913467404">This API is used to stop a specific job instance. A job instance can be stopped only when it is in the running state.</p>
|
|
</div>
|
|
<div class="section" id="dataartsstudio_02_0066__en-us_topic_0181281344_section102234449285"><h4 class="sectiontitle">URI</h4><ul id="dataartsstudio_02_0066__en-us_topic_0181281344_ul145591424184717"><li id="dataartsstudio_02_0066__en-us_topic_0181281344_li356152404715">URI format<p id="dataartsstudio_02_0066__en-us_topic_0181281344_p076674419427"><a name="dataartsstudio_02_0066__en-us_topic_0181281344_li356152404715"></a><a name="en-us_topic_0181281344_li356152404715"></a>POST /v1/{project_id}/jobs/{job_name}/instances/{instance_id}/stop</p>
|
|
</li></ul>
|
|
<ul id="dataartsstudio_02_0066__en-us_topic_0181281344_ul1370917277482"><li id="dataartsstudio_02_0066__en-us_topic_0181281344_li170972720484">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dataartsstudio_02_0066__en-us_topic_0181281344_en-us_topic_0093082049_table46023801181358" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameters</caption><thead align="left"><tr id="dataartsstudio_02_0066__en-us_topic_0181281344_en-us_topic_0093082049_row26974916181358"><th align="left" class="cellrowborder" valign="top" width="20.05%" id="mcps1.3.2.3.1.1.2.5.1.1"><p id="dataartsstudio_02_0066__en-us_topic_0181281344_en-us_topic_0093082049_p37484572181358">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="10.79%" id="mcps1.3.2.3.1.1.2.5.1.2"><p id="dataartsstudio_02_0066__en-us_topic_0181281344_en-us_topic_0093082049_p16351468181358">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15.989999999999998%" id="mcps1.3.2.3.1.1.2.5.1.3"><p id="dataartsstudio_02_0066__en-us_topic_0181281344_en-us_topic_0093082049_p49400541181358">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="53.169999999999995%" id="mcps1.3.2.3.1.1.2.5.1.4"><p id="dataartsstudio_02_0066__en-us_topic_0181281344_en-us_topic_0093082049_p42020886181358">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dataartsstudio_02_0066__en-us_topic_0181281344_en-us_topic_0093082049_row48248640181358"><td class="cellrowborder" valign="top" width="20.05%" headers="mcps1.3.2.3.1.1.2.5.1.1 "><p id="dataartsstudio_02_0066__en-us_topic_0181281344_en-us_topic_0093082049_p15825795181358">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.79%" headers="mcps1.3.2.3.1.1.2.5.1.2 "><p id="dataartsstudio_02_0066__en-us_topic_0181281344_en-us_topic_0093082049_p6820998181358">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.989999999999998%" headers="mcps1.3.2.3.1.1.2.5.1.3 "><p id="dataartsstudio_02_0066__en-us_topic_0181281344_en-us_topic_0093082049_p15629937181358">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.169999999999995%" headers="mcps1.3.2.3.1.1.2.5.1.4 "><p id="dataartsstudio_02_0066__en-us_topic_0181281344_p8672138175612">Project ID. For details about how to obtain a project ID, see <a href="projectid_accountid.html">Project ID and Account ID</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dataartsstudio_02_0066__en-us_topic_0181281344_row1571719661414"><td class="cellrowborder" valign="top" width="20.05%" headers="mcps1.3.2.3.1.1.2.5.1.1 "><p id="dataartsstudio_02_0066__en-us_topic_0181281344_p9596152417514">job_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.79%" headers="mcps1.3.2.3.1.1.2.5.1.2 "><p id="dataartsstudio_02_0066__en-us_topic_0181281344_p19718146161420">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.989999999999998%" headers="mcps1.3.2.3.1.1.2.5.1.3 "><p id="dataartsstudio_02_0066__en-us_topic_0181281344_p9718196161417">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.169999999999995%" headers="mcps1.3.2.3.1.1.2.5.1.4 "><p id="dataartsstudio_02_0066__en-us_topic_0181281344_p2571117161416">Job name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dataartsstudio_02_0066__en-us_topic_0181281344_row16215192917518"><td class="cellrowborder" valign="top" width="20.05%" headers="mcps1.3.2.3.1.1.2.5.1.1 "><p id="dataartsstudio_02_0066__en-us_topic_0181281344_p2215162915510">instance_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.79%" headers="mcps1.3.2.3.1.1.2.5.1.2 "><p id="dataartsstudio_02_0066__en-us_topic_0181281344_p1821510293519">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.989999999999998%" headers="mcps1.3.2.3.1.1.2.5.1.3 "><p id="dataartsstudio_02_0066__en-us_topic_0181281344_p6215929056">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.169999999999995%" headers="mcps1.3.2.3.1.1.2.5.1.4 "><p id="dataartsstudio_02_0066__en-us_topic_0181281344_p1215729759">Job instance ID. For details about how to obtain it, see <a href="dataartsstudio_02_0094.html">Viewing a Job Instance List</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="dataartsstudio_02_0066__en-us_topic_0181281344_section10789431145710"><h4 class="sectiontitle">Request Parameters</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dataartsstudio_02_0066__en-us_topic_0181281344_table25071810112414" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameter</caption><thead align="left"><tr id="dataartsstudio_02_0066__en-us_topic_0181281344_en-us_topic_0181281363_row3746915131710"><th align="left" class="cellrowborder" valign="top" width="15.010000000000002%" id="mcps1.3.3.2.2.5.1.1"><p id="dataartsstudio_02_0066__en-us_topic_0181281344_en-us_topic_0181281363_p131491731112013">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16.93%" id="mcps1.3.3.2.2.5.1.2"><p id="dataartsstudio_02_0066__en-us_topic_0181281344_en-us_topic_0181281363_p3149113112204">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18.73%" id="mcps1.3.3.2.2.5.1.3"><p id="dataartsstudio_02_0066__en-us_topic_0181281344_en-us_topic_0181281363_p13149173119204">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="49.33%" id="mcps1.3.3.2.2.5.1.4"><p id="dataartsstudio_02_0066__en-us_topic_0181281344_en-us_topic_0181281363_p11149331122017">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dataartsstudio_02_0066__en-us_topic_0181281344_en-us_topic_0181281363_row174620159179"><td class="cellrowborder" valign="top" width="15.010000000000002%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dataartsstudio_02_0066__en-us_topic_0181281344_en-us_topic_0181281363_p1150183116205">workspace</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.93%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dataartsstudio_02_0066__en-us_topic_0181281344_en-us_topic_0181281363_p4150531152016">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.73%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dataartsstudio_02_0066__en-us_topic_0181281344_en-us_topic_0181281363_p181505317209">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.33%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dataartsstudio_02_0066__en-us_topic_0181281344_en-us_topic_0181281363_p169341251122511">Workspace ID.</p>
|
|
<ul id="dataartsstudio_02_0066__en-us_topic_0181281344_en-us_topic_0181281363_ul776685742514"><li id="dataartsstudio_02_0066__en-us_topic_0181281344_en-us_topic_0181281363_li076655782516">If this parameter is not set, data in the <strong id="dataartsstudio_02_0066__b10923144123017">default</strong> workspace is queried by default.</li><li id="dataartsstudio_02_0066__en-us_topic_0181281344_en-us_topic_0181281363_li788605918251">To query data in other workspaces, this header must be carried.</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="dataartsstudio_02_0066__en-us_topic_0181281344_section17656611145018"><h4 class="sectiontitle">Response Parameters</h4><p id="dataartsstudio_02_0066__en-us_topic_0181281344_p748624416207">None.</p>
|
|
</div>
|
|
<div class="section" id="dataartsstudio_02_0066__en-us_topic_0181281344_section358155716277"><h4 class="sectiontitle">Example Request</h4><pre class="screen" id="dataartsstudio_02_0066__en-us_topic_0181281344_screen1692944218514">POST /v1/b384b9e9ab9b4ee8994c8633aabc9505/jobs/job_batch/instances/34765/stop</pre>
|
|
</div>
|
|
<div class="section" id="dataartsstudio_02_0066__section20205151610514"><h4 class="sectiontitle">Example Response</h4><ul id="dataartsstudio_02_0066__en-us_topic_0181281344_ul1593065043218"><li id="dataartsstudio_02_0066__en-us_topic_0181281344_li093015019327">Success response<p id="dataartsstudio_02_0066__en-us_topic_0181281344_p17457123919537"><a name="dataartsstudio_02_0066__en-us_topic_0181281344_li093015019327"></a><a name="en-us_topic_0181281344_li093015019327"></a>HTTP status code 204</p>
|
|
</li><li id="dataartsstudio_02_0066__en-us_topic_0181281344_li313082312504">Failure response<p id="dataartsstudio_02_0066__en-us_topic_0181281344_p17868101111567"><a name="dataartsstudio_02_0066__en-us_topic_0181281344_li313082312504"></a><a name="en-us_topic_0181281344_li313082312504"></a>HTTP status code 400</p>
|
|
<pre class="screen" id="dataartsstudio_02_0066__en-us_topic_0181281344_screen2818105917308">{
|
|
"error_code":"DLF.0137",
|
|
"error_msg":"Job instance does not exist."
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="dataartsstudio_02_0062.html">Job Development APIs</a></div>
|
|
</div>
|
|
</div>
|
|
|