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>
179 lines
13 KiB
HTML
179 lines
13 KiB
HTML
<a name="dli_02_0233"></a><a name="dli_02_0233"></a>
|
|
|
|
<h1 class="topictitle1">Running Jobs in Batches</h1>
|
|
<div id="body1574749525697"><div class="section" id="dli_02_0233__s89ff8bc59cba4c3b94dc17e85c8fa1ea"><h4 class="sectiontitle">Function</h4><p id="dli_02_0233__a4deaa8ebc392424e869c47835399ab23">This API is used to trigger batch job running.</p>
|
|
</div>
|
|
<div class="section" id="dli_02_0233__sef21e3efc2a44a84a03adad33a1ae006"><h4 class="sectiontitle">URI</h4><ul id="dli_02_0233__uf99c5b2f64a44669a611cae56296b336"><li id="dli_02_0233__l02802a572cd14322a9edb44c392d1063">URI format<p id="dli_02_0233__p12889420185114"><a name="dli_02_0233__l02802a572cd14322a9edb44c392d1063"></a><a name="l02802a572cd14322a9edb44c392d1063"></a>POST /v1.0/{project_id}/streaming/jobs/run</p>
|
|
</li><li id="dli_02_0233__lab001edff5ca4cde843db03812f0979d">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0233__t219b031199884ac1bb9e91158ddc9efb" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameters</caption><thead align="left"><tr id="dli_02_0233__r04005eeda24e4db9b06516450d4d56af"><th align="left" class="cellrowborder" valign="top" width="14.09%" id="mcps1.3.2.2.2.1.2.5.1.1"><p id="dli_02_0233__a80847df5e5dc448caa46a2ff258fa2c4">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="12.7%" id="mcps1.3.2.2.2.1.2.5.1.2"><p id="dli_02_0233__af54fc16087b049c98f748c1a2faace17">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="12.97%" id="mcps1.3.2.2.2.1.2.5.1.3"><p id="dli_02_0233__p263935155920">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60.24%" id="mcps1.3.2.2.2.1.2.5.1.4"><p id="dli_02_0233__a484a3e0ce14846799c727ccbd4075d6c">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dli_02_0233__r8022e11be3f54ad290cf8c848a56a550"><td class="cellrowborder" valign="top" width="14.09%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="dli_02_0233__p1262440203315">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.7%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="dli_02_0233__p1016041415356">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.97%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="dli_02_0233__p964193511598">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60.24%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="dli_02_0233__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_0233__s3afece1037ea4f62aeffb3db49b97f70"><h4 class="sectiontitle">Request</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0233__table11209133616498" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request parameters</caption><thead align="left"><tr id="dli_02_0233__row1621093613496"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.3.2.2.5.1.1"><p id="dli_02_0233__p82102036194919">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.3.2.2.5.1.2"><p id="dli_02_0233__p17210143634912">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.3.2.2.5.1.3"><p id="dli_02_0233__p15210436174916">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="45%" id="mcps1.3.3.2.2.5.1.4"><p id="dli_02_0233__p62101436144911">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dli_02_0233__row9210193614919"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0233__p122101936164915">job_ids</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0233__p12107369490">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0233__p86611443273">Array of Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0233__p1656133555018">Batch job ID. You can obtain the job ID by calling the API for creating a job or the API for querying a job.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0233__row1972335715111"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0233__p87185579515">resume_savepoint</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0233__p1671835717518">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0233__p57184571517">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0233__p1718857155112">Whether to restore a job from the latest savepoint.</p>
|
|
<ul id="dli_02_0233__ul127181857195118"><li id="dli_02_0233__li57181574516">If <span class="parmname" id="dli_02_0233__parmname1559092295313"><b>resume_savepoint</b></span> is set to <strong id="dli_02_0233__b1685552317136">true</strong>, the job is restored from the latest savepoint.</li><li id="dli_02_0233__li96146615548">If <span class="parmname" id="dli_02_0233__parmname3175145618138"><b>resume_savepoint</b></span> is set to <strong id="dli_02_0233__b77050151318">false</strong>, the job is started normally, not from a specific savepoint.</li></ul>
|
|
<p id="dli_02_0233__p15171411165419">The default value is <span class="parmvalue" id="dli_02_0233__parmvalue18819257117"><b>false</b></span>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="dli_02_0233__se2bf80cdb76541308f69f258ea4b1bd6"><h4 class="sectiontitle">Response</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0233__table19174417132516" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response parameters</caption><thead align="left"><tr id="dli_02_0233__row4174101712511"><th align="left" class="cellrowborder" valign="top" width="13.56%" id="mcps1.3.4.2.2.5.1.1"><p id="dli_02_0233__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_0233__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_0233__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_0233__p17174171712516">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dli_02_0233__row12174161712256"><td class="cellrowborder" valign="top" width="13.56%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0233__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_0233__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_0233__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_0233__p20636163692516">The response message returned is as follows: For details, see <a href="#dli_02_0233__t5995d65f65ba4ebca8606202112b407e">Table 4</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="dli_02_0233__t5995d65f65ba4ebca8606202112b407e"></a><a name="t5995d65f65ba4ebca8606202112b407e"></a><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0233__t5995d65f65ba4ebca8606202112b407e" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Array element parameters</caption><thead align="left"><tr id="dli_02_0233__ra7acea51e4b4437e917d21fe99f130a3"><th align="left" class="cellrowborder" valign="top" width="13.56%" id="mcps1.3.4.3.2.5.1.1"><p id="dli_02_0233__a5af940f2267747ef871c67c86a0be82e">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="13.59%" id="mcps1.3.4.3.2.5.1.2"><p id="dli_02_0233__abcfbd3a651704d539626f3a41cc744f5">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18.52%" id="mcps1.3.4.3.2.5.1.3"><p id="dli_02_0233__a2351d8d266444ad3ad1c09540d6d81cc">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="54.33%" id="mcps1.3.4.3.2.5.1.4"><p id="dli_02_0233__af7ea6a3f59844bdf99d51e90d570be4c">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dli_02_0233__row2418154742"><td class="cellrowborder" valign="top" width="13.56%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dli_02_0233__p10253165219311">is_success</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.59%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0233__p8253115273111">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.52%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0233__p7253352153116">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54.33%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0233__p8253152103110">Whether the request is successfully executed. Value <span class="parmvalue" id="dli_02_0233__parmvalue8642332121516"><b>true</b></span> indicates that the request is successfully executed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0233__row64180541741"><td class="cellrowborder" valign="top" width="13.56%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dli_02_0233__a4aba020b918e457a8a3d15e7ebaeb20d">message</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.59%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0233__p11374111319494">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.52%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0233__ac85edc0a27d044b0ad524a4124e59e4c">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54.33%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0233__ac087aec9dfcc407ba244ad3e96b23257">Message content.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="dli_02_0233__section1130754105710"><h4 class="sectiontitle">Example Request</h4><p id="dli_02_0233__p1662123061614">Run the jobs whose IDs are <strong id="dli_02_0233__b10647675518">131</strong>, <strong id="dli_02_0233__b91951897519">130</strong>, <strong id="dli_02_0233__b4676201575116">138</strong>, and <strong id="dli_02_0233__b10846618185114">137</strong> and allow the jobs to be restored from their latest savepoints.</p>
|
|
<pre class="screen" id="dli_02_0233__screen15209183612499">{
|
|
"job_ids": [131,130,138,137],
|
|
"resume_savepoint": true
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="dli_02_0233__section132501434144"><h4 class="sectiontitle">Example Response</h4><pre class="screen" id="dli_02_0233__s6d0d234a671f4e618d1a2b5e746cff26">[
|
|
{
|
|
"is_success": "true",
|
|
"message": "The request for submitting DLI jobs is delivered successfully."
|
|
},
|
|
{
|
|
"is_success": "true",
|
|
"message": "The request for submitting DLI jobs is delivered successfully."
|
|
},
|
|
{
|
|
"is_success": "true",
|
|
"message": "The request for submitting DLI jobs is delivered successfully."
|
|
},
|
|
{
|
|
"is_success": "true",
|
|
"message": "The request for submitting DLI jobs is delivered successfully."
|
|
}
|
|
]</pre>
|
|
</div>
|
|
<div class="section" id="dli_02_0233__s1b495ba11cd9411c9ad2ee50103334a7"><h4 class="sectiontitle">Status Codes</h4><p id="dli_02_0233__acef1445366354016b2ed90921927a555"><a href="#dli_02_0233__t43c1f1c0ba344f4cbcb270953d9cca2a">Table 5</a> describes status codes.</p>
|
|
|
|
<div class="tablenoborder"><a name="dli_02_0233__t43c1f1c0ba344f4cbcb270953d9cca2a"></a><a name="t43c1f1c0ba344f4cbcb270953d9cca2a"></a><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0233__t43c1f1c0ba344f4cbcb270953d9cca2a" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Status codes</caption><thead align="left"><tr id="dli_02_0233__r2ad0f008ce2248a1800a3e8b77226a56"><th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.7.3.2.3.1.1"><p id="dli_02_0233__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_0233__af801170b350b4f8ba3b575c7ddb8b13e">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dli_02_0233__r0b449b1d3b8c498ea3e6cce16c80a14c"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.7.3.2.3.1.1 "><p id="dli_02_0233__p83035385116">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.7.3.2.3.1.2 "><p id="dli_02_0233__af86844c7bb364c48b6300df1af164af2">Jobs are successfully run in batches.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0233__row14817183818516"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.7.3.2.3.1.1 "><p id="dli_02_0233__p2817113875117">400</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.7.3.2.3.1.2 "><p id="dli_02_0233__p5817133855113">The input parameter is invalid.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="dli_02_0233__section13596141025715"><h4 class="sectiontitle">Error Codes</h4><p id="dli_02_0233__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>
|
|
|