forked from docs/doc-exports
Su, Xiaomeng
483e5cc6cc
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>
162 lines
13 KiB
HTML
162 lines
13 KiB
HTML
<a name="dli_02_0241"></a><a name="dli_02_0241"></a>
|
|
|
|
<h1 class="topictitle1">Stopping Jobs in Batches</h1>
|
|
<div id="body1574749525738"><div class="section" id="dli_02_0241__s89ff8bc59cba4c3b94dc17e85c8fa1ea"><h4 class="sectiontitle">Function</h4><p id="dli_02_0241__a4deaa8ebc392424e869c47835399ab23">This API is used to stop running jobs in batches.</p>
|
|
</div>
|
|
<div class="section" id="dli_02_0241__sef21e3efc2a44a84a03adad33a1ae006"><h4 class="sectiontitle">URI</h4><ul id="dli_02_0241__uf99c5b2f64a44669a611cae56296b336"><li id="dli_02_0241__l02802a572cd14322a9edb44c392d1063">URI format<p id="dli_02_0241__p19933124510812"><a name="dli_02_0241__l02802a572cd14322a9edb44c392d1063"></a><a name="l02802a572cd14322a9edb44c392d1063"></a>POST /v1.0/{project_id}/streaming/jobs/stop</p>
|
|
</li><li id="dli_02_0241__lab001edff5ca4cde843db03812f0979d">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0241__t219b031199884ac1bb9e91158ddc9efb" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameters</caption><thead align="left"><tr id="dli_02_0241__r04005eeda24e4db9b06516450d4d56af"><th align="left" class="cellrowborder" valign="top" width="13.58%" id="mcps1.3.2.2.2.1.2.5.1.1"><p id="dli_02_0241__a80847df5e5dc448caa46a2ff258fa2c4">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="11.76%" id="mcps1.3.2.2.2.1.2.5.1.2"><p id="dli_02_0241__af54fc16087b049c98f748c1a2faace17">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="11.450000000000001%" id="mcps1.3.2.2.2.1.2.5.1.3"><p id="dli_02_0241__p512595865612">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="63.21%" id="mcps1.3.2.2.2.1.2.5.1.4"><p id="dli_02_0241__a484a3e0ce14846799c727ccbd4075d6c">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dli_02_0241__r8022e11be3f54ad290cf8c848a56a550"><td class="cellrowborder" valign="top" width="13.58%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="dli_02_0241__p1262440203315">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.76%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="dli_02_0241__p1016041415356">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.450000000000001%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="dli_02_0241__p151269589568">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63.21%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="dli_02_0241__p1768719515356">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>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="dli_02_0241__s3afece1037ea4f62aeffb3db49b97f70"><h4 class="sectiontitle">Request</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0241__table11209133616498" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request parameters</caption><thead align="left"><tr id="dli_02_0241__row1621093613496"><th align="left" class="cellrowborder" valign="top" width="16.150000000000002%" id="mcps1.3.3.2.2.5.1.1"><p id="dli_02_0241__p82102036194919">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="10.12%" id="mcps1.3.3.2.2.5.1.2"><p id="dli_02_0241__p17210143634912">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15.67%" id="mcps1.3.3.2.2.5.1.3"><p id="dli_02_0241__p15210436174916">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="58.06%" id="mcps1.3.3.2.2.5.1.4"><p id="dli_02_0241__p62101436144911">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dli_02_0241__row9210193614919"><td class="cellrowborder" valign="top" width="16.150000000000002%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0241__p122101936164915">job_ids</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.12%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0241__p12107369490">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.67%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0241__p14210736184920">Array of Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.06%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0241__p1656133555018">Job ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0241__row17196152718418"><td class="cellrowborder" valign="top" width="16.150000000000002%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0241__p16184102718412">trigger_savepoint</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.12%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0241__p6185527341">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.67%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0241__p151851271841">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.06%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0241__p181851327044">Whether to create a savepoint for a job to store the job status information before stopping it. The data type is Boolean.</p>
|
|
<ul id="dli_02_0241__ul19185627141"><li id="dli_02_0241__li218522714415">If this parameter is set to <strong id="dli_02_0241__b61311359173212">true</strong>, a savepoint is created.</li><li id="dli_02_0241__li918516276418">If this parameter is set to <strong id="dli_02_0241__b12947467331">false</strong>, no savepoint is created. The default value is <strong id="dli_02_0241__b122422973315">false</strong>.</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="dli_02_0241__se2bf80cdb76541308f69f258ea4b1bd6"><h4 class="sectiontitle">Response</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0241__table19174417132516" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response parameters</caption><thead align="left"><tr id="dli_02_0241__row4174101712511"><th align="left" class="cellrowborder" valign="top" width="13.56%" id="mcps1.3.4.2.2.5.1.1"><p id="dli_02_0241__p181742176254">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="13.59%" id="mcps1.3.4.2.2.5.1.2"><p id="dli_02_0241__p13174161710258">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18.52%" id="mcps1.3.4.2.2.5.1.3"><p id="dli_02_0241__p17174141718255">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="54.33%" id="mcps1.3.4.2.2.5.1.4"><p id="dli_02_0241__p17174171712516">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dli_02_0241__row12174161712256"><td class="cellrowborder" valign="top" width="13.56%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0241__p8598193611254">Array elements</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.59%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0241__p19629193652511">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.52%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0241__p1063263611250">Array of Objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54.33%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0241__p20636163692516">The response message returned is as follows: For details, see <a href="#dli_02_0241__t5995d65f65ba4ebca8606202112b407e">Table 4</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="dli_02_0241__t5995d65f65ba4ebca8606202112b407e"></a><a name="t5995d65f65ba4ebca8606202112b407e"></a><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0241__t5995d65f65ba4ebca8606202112b407e" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Array element parameters</caption><thead align="left"><tr id="dli_02_0241__ra7acea51e4b4437e917d21fe99f130a3"><th align="left" class="cellrowborder" valign="top" width="16.919999999999998%" id="mcps1.3.4.3.2.5.1.1"><p id="dli_02_0241__a5af940f2267747ef871c67c86a0be82e">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15.629999999999999%" id="mcps1.3.4.3.2.5.1.2"><p id="dli_02_0241__abcfbd3a651704d539626f3a41cc744f5">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20.19%" id="mcps1.3.4.3.2.5.1.3"><p id="dli_02_0241__a2351d8d266444ad3ad1c09540d6d81cc">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="47.260000000000005%" id="mcps1.3.4.3.2.5.1.4"><p id="dli_02_0241__af7ea6a3f59844bdf99d51e90d570be4c">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dli_02_0241__row2418154742"><td class="cellrowborder" valign="top" width="16.919999999999998%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dli_02_0241__p10253165219311">is_success</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.629999999999999%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0241__p8253115273111">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.19%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0241__p7253352153116">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="47.260000000000005%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0241__p8253152103110">Whether the request is successfully executed. Value <span class="parmvalue" id="dli_02_0241__parmvalue189018401386"><b>true</b></span> indicates that the request is successfully executed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0241__row64180541741"><td class="cellrowborder" valign="top" width="16.919999999999998%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dli_02_0241__a4aba020b918e457a8a3d15e7ebaeb20d">message</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.629999999999999%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0241__p11374111319494">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.19%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0241__ac85edc0a27d044b0ad524a4124e59e4c">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="47.260000000000005%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0241__ac087aec9dfcc407ba244ad3e96b23257">Message content</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="dli_02_0241__section1130754105710"><h4 class="sectiontitle">Example Request</h4><p id="dli_02_0241__p9442123417123">Stop the jobs whose IDs are <strong id="dli_02_0241__b15792115795211">128</strong> and <strong id="dli_02_0241__b11202165995211">137</strong>.</p>
|
|
<pre class="screen" id="dli_02_0241__screen15209183612499">{
|
|
"job_ids": [128, 137],
|
|
"trigger_savepoint": false
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="dli_02_0241__section167779421883"><h4 class="sectiontitle">Example Response</h4><pre class="screen" id="dli_02_0241__screen13148183015109">[{"is_success":"true",
|
|
"message": "The request for stopping DLI jobs is delivered successfully."}]</pre>
|
|
</div>
|
|
<div class="section" id="dli_02_0241__s1b495ba11cd9411c9ad2ee50103334a7"><h4 class="sectiontitle">Status Codes</h4><p id="dli_02_0241__acef1445366354016b2ed90921927a555"><a href="#dli_02_0241__t43c1f1c0ba344f4cbcb270953d9cca2a">Table 5</a> describes status codes.</p>
|
|
|
|
<div class="tablenoborder"><a name="dli_02_0241__t43c1f1c0ba344f4cbcb270953d9cca2a"></a><a name="t43c1f1c0ba344f4cbcb270953d9cca2a"></a><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0241__t43c1f1c0ba344f4cbcb270953d9cca2a" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Status codes</caption><thead align="left"><tr id="dli_02_0241__r2ad0f008ce2248a1800a3e8b77226a56"><th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.7.3.2.3.1.1"><p id="dli_02_0241__afa33b7f5b0ac4d008ebcf6493f629b24">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_0241__af801170b350b4f8ba3b575c7ddb8b13e">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dli_02_0241__r0b449b1d3b8c498ea3e6cce16c80a14c"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.7.3.2.3.1.1 "><p id="dli_02_0241__a8c63a97e3bad402ebaead0bd99cad632">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.7.3.2.3.1.2 "><p id="dli_02_0241__af86844c7bb364c48b6300df1af164af2">The request of stopping a job is sent successfully.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0241__row1047615129577"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.7.3.2.3.1.1 "><p id="dli_02_0241__p04764125576">400</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.7.3.2.3.1.2 "><p id="dli_02_0241__p1247618125573">The input parameter is invalid.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="dli_02_0241__section13596141025715"><h4 class="sectiontitle">Error Codes</h4><p id="dli_02_0241__dli_02_0225_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_0223.html">Flink Job-related APIs</a></div>
|
|
</div>
|
|
</div>
|
|
|