vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/dli/api-ref/dli_02_0231.html
Su, Xiaomeng 483e5cc6cc dli_api_20240430 
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>
2024-05-15 12:04:03 +00:00

384 lines
29 KiB
HTML
Raw Blame History

<a name="dli_02_0231"></a><a name="dli_02_0231"></a>
<h1 class="topictitle1">Updating a Flink Jar Job</h1>
<div id="body1574749525687"><div class="section" id="dli_02_0231__s89ff8bc59cba4c3b94dc17e85c8fa1ea"><h4 class="sectiontitle">Function</h4><p id="dli_02_0231__a4deaa8ebc392424e869c47835399ab23">This API is used to update custom jobs, which currently support the JAR format and run in dedicated queues.</p>
</div>
<div class="section" id="dli_02_0231__sef21e3efc2a44a84a03adad33a1ae006"><h4 class="sectiontitle">URI</h4><ul id="dli_02_0231__uf99c5b2f64a44669a611cae56296b336"><li id="dli_02_0231__l02802a572cd14322a9edb44c392d1063">URI format<p id="dli_02_0231__ab9f59a1049d24cb2a9c51b9ed06e59d4"><a name="dli_02_0231__l02802a572cd14322a9edb44c392d1063"></a><a name="l02802a572cd14322a9edb44c392d1063"></a>PUT /v1.0/{<em id="dli_02_0231__i893410203411">project_id</em>}/streaming/flink-jobs/{<em id="dli_02_0231__i1753392464115">job_id</em>}</p>
</li><li id="dli_02_0231__lab001edff5ca4cde843db03812f0979d">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0231__t219b031199884ac1bb9e91158ddc9efb" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameters</caption><thead align="left"><tr id="dli_02_0231__r04005eeda24e4db9b06516450d4d56af"><th align="left" class="cellrowborder" valign="top" width="17.47%" id="mcps1.3.2.2.2.1.2.5.1.1"><p id="dli_02_0231__a80847df5e5dc448caa46a2ff258fa2c4">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="11.62%" id="mcps1.3.2.2.2.1.2.5.1.2"><p id="dli_02_0231__af54fc16087b049c98f748c1a2faace17">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="11.39%" id="mcps1.3.2.2.2.1.2.5.1.3"><p id="dli_02_0231__p32272013232">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="59.519999999999996%" id="mcps1.3.2.2.2.1.2.5.1.4"><p id="dli_02_0231__a484a3e0ce14846799c727ccbd4075d6c">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dli_02_0231__r8022e11be3f54ad290cf8c848a56a550"><td class="cellrowborder" valign="top" width="17.47%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="dli_02_0231__p1262440203315">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="11.62%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="dli_02_0231__p1016041415356">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="11.39%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="dli_02_0231__p1623820142310">String</p>
</td>
<td class="cellrowborder" valign="top" width="59.519999999999996%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="dli_02_0231__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>
<tr id="dli_02_0231__row14405113219254"><td class="cellrowborder" valign="top" width="17.47%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="dli_02_0231__p12397103222510">job_id</p>
</td>
<td class="cellrowborder" valign="top" width="11.62%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="dli_02_0231__p6397173282519">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="11.39%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="dli_02_0231__p52372052319">Long</p>
</td>
<td class="cellrowborder" valign="top" width="59.519999999999996%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="dli_02_0231__p139783292519">Job ID. Refer to <a href="dli_02_0230.html">Creating a Flink Jar job</a> to obtain the value.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="dli_02_0231__s3afece1037ea4f62aeffb3db49b97f70"><h4 class="sectiontitle">Request</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0231__table167338273210" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="dli_02_0231__row473492772112"><th align="left" class="cellrowborder" valign="top" width="21.21%" id="mcps1.3.3.2.2.5.1.1"><p id="dli_02_0231__p1473442722114">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="11.89%" id="mcps1.3.3.2.2.5.1.2"><p id="dli_02_0231__p162850283265">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="11.360000000000001%" id="mcps1.3.3.2.2.5.1.3"><p id="dli_02_0231__p1886715014454">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="55.54%" id="mcps1.3.3.2.2.5.1.4"><p id="dli_02_0231__p1873432716213">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dli_02_0231__row137341727132113"><td class="cellrowborder" valign="top" width="21.21%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0231__p6734122720213">name</p>
</td>
<td class="cellrowborder" valign="top" width="11.89%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0231__p16241141810311">No</p>
</td>
<td class="cellrowborder" valign="top" width="11.360000000000001%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0231__p394123011411">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.54%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0231__p12734427152118">Name of the job. Length range: 0 to 57 characters.</p>
</td>
</tr>
<tr id="dli_02_0231__row157341727112111"><td class="cellrowborder" valign="top" width="21.21%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0231__p37343278217">desc</p>
</td>
<td class="cellrowborder" valign="top" width="11.89%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0231__p16241121816313">No</p>
</td>
<td class="cellrowborder" valign="top" width="11.360000000000001%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0231__p134186214816">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.54%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0231__p207341827192110">Job description. Length range: 0 to 512 characters.</p>
</td>
</tr>
<tr id="dli_02_0231__row16658203116445"><td class="cellrowborder" valign="top" width="21.21%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0231__p621523961515">queue_name</p>
</td>
<td class="cellrowborder" valign="top" width="11.89%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0231__p1721515390153">No</p>
</td>
<td class="cellrowborder" valign="top" width="11.360000000000001%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0231__p82151339141519">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.54%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0231__p821553918157">Name of a queue. Length range: 1 to 128 characters.</p>
</td>
</tr>
<tr id="dli_02_0231__row573417279212"><td class="cellrowborder" valign="top" width="21.21%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0231__p1773410271210">cu_number</p>
</td>
<td class="cellrowborder" valign="top" width="11.89%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0231__p9285328122610">No</p>
</td>
<td class="cellrowborder" valign="top" width="11.360000000000001%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0231__p191902533811">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="55.54%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0231__p157341327112113">Number of CUs selected for a job. The default value is <strong id="dli_02_0231__b1068913171848">2</strong>.</p>
</td>
</tr>
<tr id="dli_02_0231__row7559945576"><td class="cellrowborder" valign="top" width="21.21%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0231__p1855915451171">manager_cu_number</p>
</td>
<td class="cellrowborder" valign="top" width="11.89%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0231__p15285102816263">No</p>
</td>
<td class="cellrowborder" valign="top" width="11.360000000000001%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0231__p152915285475">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="55.54%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0231__p1056011451171">Number of CUs on the management node selected by the user for a job, which corresponds to the number of Flink job managers. The default value is <strong id="dli_02_0231__b84235270615612">1</strong>.</p>
</td>
</tr>
<tr id="dli_02_0231__row873413275210"><td class="cellrowborder" valign="top" width="21.21%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0231__p978704819454">parallel_number</p>
</td>
<td class="cellrowborder" valign="top" width="11.89%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0231__p728517285262">No</p>
</td>
<td class="cellrowborder" valign="top" width="11.360000000000001%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0231__p14728172409">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="55.54%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0231__p15964644992">Number of parallel operations selected for a job. The default value is <strong id="dli_02_0231__b582093927">1</strong>.</p>
</td>
</tr>
<tr id="dli_02_0231__row1679750142215"><td class="cellrowborder" valign="top" width="21.21%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0231__p19797100225">log_enabled</p>
</td>
<td class="cellrowborder" valign="top" width="11.89%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0231__p228517281267">No</p>
</td>
<td class="cellrowborder" valign="top" width="11.360000000000001%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0231__p585014405335">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="55.54%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0231__p167975032213">Whether to enable the job log function.</p>
<ul id="dli_02_0231__ul960951941319"><li id="dli_02_0231__li1960812195138"><strong id="dli_02_0231__b11170163017412">true</strong>: indicates to enable the job log function.</li><li id="dli_02_0231__li1660811981313"><strong id="dli_02_0231__b18614173212412">false</strong>: indicates to disable the job log function.</li><li id="dli_02_0231__li1460951901319">Default value: <strong id="dli_02_0231__b75463629211402">false</strong></li></ul>
</td>
</tr>
<tr id="dli_02_0231__row5797130182213"><td class="cellrowborder" valign="top" width="21.21%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0231__p127987013227">obs_bucket</p>
</td>
<td class="cellrowborder" valign="top" width="11.89%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0231__p52851928142618">No</p>
</td>
<td class="cellrowborder" valign="top" width="11.360000000000001%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0231__p244659164112">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.54%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0231__p14798100122220">OBS bucket where users are authorized to save logs when <strong id="dli_02_0231__b84235270614412">log_enabled</strong> is set to <strong id="dli_02_0231__b84235270614419">true</strong>.</p>
</td>
</tr>
<tr id="dli_02_0231__row1611453494219"><td class="cellrowborder" valign="top" width="21.21%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0231__p911463474212">smn_topic</p>
</td>
<td class="cellrowborder" valign="top" width="11.89%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0231__p1228772813267">No</p>
</td>
<td class="cellrowborder" valign="top" width="11.360000000000001%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0231__p285034019338">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.54%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0231__p211453410422">SMN topic. If a job fails, the system will send a message to users subscribed to the SMN topic.</p>
</td>
</tr>
<tr id="dli_02_0231__row1667713917350"><td class="cellrowborder" valign="top" width="21.21%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0231__p1767811915356">main_class</p>
</td>
<td class="cellrowborder" valign="top" width="11.89%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0231__p17287112813264">No</p>
</td>
<td class="cellrowborder" valign="top" width="11.360000000000001%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0231__p18966151111382">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.54%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0231__p867818923519">Job entry class.</p>
</td>
</tr>
<tr id="dli_02_0231__row1567815917356"><td class="cellrowborder" valign="top" width="21.21%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0231__p1067811920359">entrypoint_args</p>
</td>
<td class="cellrowborder" valign="top" width="11.89%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0231__p182871828172619">No</p>
</td>
<td class="cellrowborder" valign="top" width="11.360000000000001%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0231__p1696618119384">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.54%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0231__p1367814923518">Job entry parameter. Multiple parameters are separated by spaces.</p>
</td>
</tr>
<tr id="dli_02_0231__row0400711104617"><td class="cellrowborder" valign="top" width="21.21%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0231__p8559173762410">restart_when_exception</p>
</td>
<td class="cellrowborder" valign="top" width="11.89%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0231__p256063714247">No</p>
</td>
<td class="cellrowborder" valign="top" width="11.360000000000001%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0231__p84861029174011">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="55.54%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0231__p85601437192419">Whether to enable the function of restart upon exceptions. The default value is <strong id="dli_02_0231__b11975730515">false</strong>.</p>
</td>
</tr>
<tr id="dli_02_0231__row990643862714"><td class="cellrowborder" valign="top" width="21.21%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0231__p8948157185118">entrypoint</p>
</td>
<td class="cellrowborder" valign="top" width="11.89%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0231__p119484755116">No</p>
</td>
<td class="cellrowborder" valign="top" width="11.360000000000001%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0231__p49487710511">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.54%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0231__p14948375511">Name of the package that has been uploaded to the DLI resource management system. This parameter is used to customize the JAR file where the job main class is located.</p>
</td>
</tr>
<tr id="dli_02_0231__row11904133882719"><td class="cellrowborder" valign="top" width="21.21%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0231__p7233155624618">dependency_jars</p>
</td>
<td class="cellrowborder" valign="top" width="11.89%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0231__p42331956124615">No</p>
</td>
<td class="cellrowborder" valign="top" width="11.360000000000001%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0231__p9233155654619">Array of Strings</p>
</td>
<td class="cellrowborder" valign="top" width="55.54%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0231__p8233135664619">Name of the package that has been uploaded to the DLI resource management system. This parameter is used to customize other dependency packages.</p>
<p id="dli_02_0231__p19536182203415">Example: <strong id="dli_02_0231__b189681017559">myGroup/test.jar,myGroup/test1.jar</strong>.</p>
</td>
</tr>
<tr id="dli_02_0231__row10453145518316"><td class="cellrowborder" valign="top" width="21.21%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0231__p174899543309">dependency_files</p>
</td>
<td class="cellrowborder" valign="top" width="11.89%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0231__p1548919541305">No</p>
</td>
<td class="cellrowborder" valign="top" width="11.360000000000001%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0231__p748975419303">Array of Strings</p>
</td>
<td class="cellrowborder" valign="top" width="55.54%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0231__p12748153919317">Name of the resource package that has been uploaded to the DLI resource management system. This parameter is used to customize dependency files.</p>
<p id="dli_02_0231__p948945412308">Example: <strong id="dli_02_0231__b124172819518">myGroup/test.cvs,myGroup/test1.csv</strong>.</p>
</td>
</tr>
<tr id="dli_02_0231__row92590405160"><td class="cellrowborder" valign="top" width="21.21%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0231__p62741531828">tm_cus</p>
</td>
<td class="cellrowborder" valign="top" width="11.89%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0231__p1827415533218">No</p>
</td>
<td class="cellrowborder" valign="top" width="11.360000000000001%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0231__p132740531925">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="55.54%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0231__p9274165315217">Number of CUs for each TaskManager. The default value is <strong id="dli_02_0231__b239516415412">1</strong>.</p>
</td>
</tr>
<tr id="dli_02_0231__row1257340101614"><td class="cellrowborder" valign="top" width="21.21%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0231__p122748531625">tm_slot_num</p>
</td>
<td class="cellrowborder" valign="top" width="11.89%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0231__p1274125315210">No</p>
</td>
<td class="cellrowborder" valign="top" width="11.360000000000001%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0231__p1327455313218">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="55.54%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0231__p4275145317210">Number of slots in each TaskManager. The default value is <strong id="dli_02_0231__b12435184415">(parallel_number*tm_cus)/(cu_number-manager_cu_number)</strong>.</p>
</td>
</tr>
<tr id="dli_02_0231__row10334442111816"><td class="cellrowborder" valign="top" width="21.21%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0231__p2335124251810">resume_checkpoint</p>
</td>
<td class="cellrowborder" valign="top" width="11.89%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0231__p173354422187">No</p>
</td>
<td class="cellrowborder" valign="top" width="11.360000000000001%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0231__p113357429186">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="55.54%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0231__p233519428187">Whether the abnormal restart is recovered from the checkpoint.</p>
</td>
</tr>
<tr id="dli_02_0231__row1335174201818"><td class="cellrowborder" valign="top" width="21.21%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0231__p3543245162311">resume_max_num</p>
</td>
<td class="cellrowborder" valign="top" width="11.89%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0231__p9541245182312">No</p>
</td>
<td class="cellrowborder" valign="top" width="11.360000000000001%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0231__p185409459238">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="55.54%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0231__p1549119459232">Maximum number of retry times upon exceptions. The unit is times/hour. Value range: -1 or greater than 0. The default value is <strong id="dli_02_0231__b81161142114118">-1</strong>, indicating that the number of times is unlimited.</p>
</td>
</tr>
<tr id="dli_02_0231__row8336174231812"><td class="cellrowborder" valign="top" width="21.21%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0231__p1336124261814">checkpoint_path</p>
</td>
<td class="cellrowborder" valign="top" width="11.89%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0231__p153361942171813">No</p>
</td>
<td class="cellrowborder" valign="top" width="11.360000000000001%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0231__p73361242191816">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.54%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0231__p633644216183">Storage address of the checkpoint in the JAR file of the user. The path must be unique.</p>
</td>
</tr>
<tr id="dli_02_0231__row173425118576"><td class="cellrowborder" valign="top" width="21.21%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0231__p95362034690">runtime_config</p>
</td>
<td class="cellrowborder" valign="top" width="11.89%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0231__p165376345912">No</p>
</td>
<td class="cellrowborder" valign="top" width="11.360000000000001%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0231__p25373349919">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.54%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0231__p1153712346915">Customizes optimization parameters when a Flink job is running.</p>
</td>
</tr>
<tr id="dli_02_0231__row1037523216445"><td class="cellrowborder" valign="top" width="21.21%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0231__p1037514327446">job_type</p>
</td>
<td class="cellrowborder" valign="top" width="11.89%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0231__p6375132144417">No</p>
</td>
<td class="cellrowborder" valign="top" width="11.360000000000001%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0231__p1537511328445">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.54%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0231__p1737613213444">Job types.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="dli_02_0231__se2bf80cdb76541308f69f258ea4b1bd6"><h4 class="sectiontitle">Response</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0231__t5995d65f65ba4ebca8606202112b407e" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response parameters</caption><thead align="left"><tr id="dli_02_0231__ra7acea51e4b4437e917d21fe99f130a3"><th align="left" class="cellrowborder" valign="top" width="16.439999999999998%" id="mcps1.3.4.2.2.5.1.1"><p id="dli_02_0231__a5af940f2267747ef871c67c86a0be82e">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15.370000000000001%" id="mcps1.3.4.2.2.5.1.2"><p id="dli_02_0231__abcfbd3a651704d539626f3a41cc744f5">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="13.86%" id="mcps1.3.4.2.2.5.1.3"><p id="dli_02_0231__a2351d8d266444ad3ad1c09540d6d81cc">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_0231__af7ea6a3f59844bdf99d51e90d570be4c">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dli_02_0231__row2418154742"><td class="cellrowborder" valign="top" width="16.439999999999998%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0231__p10253165219311">is_success</p>
</td>
<td class="cellrowborder" valign="top" width="15.370000000000001%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0231__p8253115273111">No</p>
</td>
<td class="cellrowborder" valign="top" width="13.86%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0231__p7253352153116">String</p>
</td>
<td class="cellrowborder" valign="top" width="54.33%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0231__p8253152103110">Whether the request is successfully executed. Value <span class="parmvalue" id="dli_02_0231__parmvalue13420521655"><b>true</b></span> indicates that the request is successfully executed.</p>
</td>
</tr>
<tr id="dli_02_0231__row64180541741"><td class="cellrowborder" valign="top" width="16.439999999999998%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0231__a4aba020b918e457a8a3d15e7ebaeb20d">message</p>
</td>
<td class="cellrowborder" valign="top" width="15.370000000000001%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0231__p11374111319494">No</p>
</td>
<td class="cellrowborder" valign="top" width="13.86%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0231__ac85edc0a27d044b0ad524a4124e59e4c">String</p>
</td>
<td class="cellrowborder" valign="top" width="54.33%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0231__ac087aec9dfcc407ba244ad3e96b23257">Message content.</p>
</td>
</tr>
<tr id="dli_02_0231__row13575616163215"><td class="cellrowborder" valign="top" width="16.439999999999998%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0231__p1457691643219">job</p>
</td>
<td class="cellrowborder" valign="top" width="15.370000000000001%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0231__p3576151610328">No</p>
</td>
<td class="cellrowborder" valign="top" width="13.86%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0231__p5576316153211">object</p>
</td>
<td class="cellrowborder" valign="top" width="54.33%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0231__p15761162327">Information about job update. For details, see <a href="#dli_02_0231__table128621016345">Table 4</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="dli_02_0231__table128621016345"></a><a name="table128621016345"></a><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0231__table128621016345" frame="border" border="1" rules="all"><caption><b>Table 4 </b><strong id="dli_02_0231__b3868195915514">job</strong> parameters</caption><thead align="left"><tr id="dli_02_0231__row88741014347"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.3.2.5.1.1"><p id="dli_02_0231__p1487161063413">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.4.3.2.5.1.2"><p id="dli_02_0231__p1287810113413">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="12.57%" id="mcps1.3.4.3.2.5.1.3"><p id="dli_02_0231__p128817104349">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="47.43%" id="mcps1.3.4.3.2.5.1.4"><p id="dli_02_0231__p1788151013347">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dli_02_0231__row2090131017345"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dli_02_0231__p1905104345">update_time</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0231__p89016106346">No</p>
</td>
<td class="cellrowborder" valign="top" width="12.57%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0231__p4901103344">Long</p>
</td>
<td class="cellrowborder" valign="top" width="47.43%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0231__p59012101344">Time when a job is updated. The unit is millisecond.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="dli_02_0231__section1130754105710"><h4 class="sectiontitle">Example Request</h4><p id="dli_02_0231__p11818592111">Update the Flink Jar job information. After the update, the job name is <strong id="dli_02_0231__b10893195164715">test1</strong>, the job execution queue is <strong id="dli_02_0231__b78037269494">testQueue</strong>, and the job log function is disabled.</p>
<pre class="screen" id="dli_02_0231__screen6161182151710">{
"name": "test1",
"desc": "job for test",
"job_type": "flink_jar_job",
"queue_name": "testQueue",
"manager_cu_number": 1,
"cu_number": 2,
"parallel_number": 1,
"log_enabled": false,
"main_class": "org.apache.flink.examples.streaming.JavaQueueStream",
"restart_when_exception": false,
"entrypoint": "FemaleInfoCollec.jar",
"dependency_jars": [
"myGroup/test.jar",
"myGroup/test1.jar"
],
"dependency_files": [
"myGroup/test.csv",
"myGroup/test1.csv"
]
}</pre>
</div>
<div class="section" id="dli_02_0231__section931494182219"><h4 class="sectiontitle">Example Response</h4><pre class="screen" id="dli_02_0231__s6d0d234a671f4e618d1a2b5e746cff26">{
"is_success": true,
"message": "The Flink job is updated successfully.",
"job": {
"update_time": 1516952770835
}
}</pre>
</div>
<div class="section" id="dli_02_0231__s1b495ba11cd9411c9ad2ee50103334a7"><h4 class="sectiontitle">Status Codes</h4><p id="dli_02_0231__acef1445366354016b2ed90921927a555"><a href="#dli_02_0231__t43c1f1c0ba344f4cbcb270953d9cca2a">Table 5</a> describes status codes.</p>
<div class="tablenoborder"><a name="dli_02_0231__t43c1f1c0ba344f4cbcb270953d9cca2a"></a><a name="t43c1f1c0ba344f4cbcb270953d9cca2a"></a><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0231__t43c1f1c0ba344f4cbcb270953d9cca2a" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Status codes</caption><thead align="left"><tr id="dli_02_0231__r2ad0f008ce2248a1800a3e8b77226a56"><th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.7.3.2.3.1.1"><p id="dli_02_0231__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_0231__af801170b350b4f8ba3b575c7ddb8b13e">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dli_02_0231__r0b449b1d3b8c498ea3e6cce16c80a14c"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.7.3.2.3.1.1 "><p id="dli_02_0231__a8c63a97e3bad402ebaead0bd99cad632">200</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.7.3.2.3.1.2 "><p id="dli_02_0231__af86844c7bb364c48b6300df1af164af2">The custom Flink job is updated successfully.</p>
</td>
</tr>
<tr id="dli_02_0231__row1012873412149"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.7.3.2.3.1.1 "><p id="dli_02_0231__p1912813348145">400</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.7.3.2.3.1.2 "><p id="dli_02_0231__p154287617445">The input parameter is invalid.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="dli_02_0231__section13596141025715"><h4 class="sectiontitle">Error Codes</h4><p id="dli_02_0231__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>
View Git Blame Copy Permalink