vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/dli/api-ref/dli_02_0229.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

437 lines
35 KiB
HTML
Raw Blame History

<a name="dli_02_0229"></a><a name="dli_02_0229"></a>
<h1 class="topictitle1">Updating a SQL Job</h1>
<div id="body1574749525238"><div class="section" id="dli_02_0229__s89ff8bc59cba4c3b94dc17e85c8fa1ea"><h4 class="sectiontitle">Function</h4><p id="dli_02_0229__p138171836185714">This API is used to modify a Flink SQL job.</p>
</div>
<div class="section" id="dli_02_0229__sef21e3efc2a44a84a03adad33a1ae006"><h4 class="sectiontitle">URI</h4><ul id="dli_02_0229__uf99c5b2f64a44669a611cae56296b336"><li id="dli_02_0229__l02802a572cd14322a9edb44c392d1063">URI format<p id="dli_02_0229__ab9f59a1049d24cb2a9c51b9ed06e59d4"><a name="dli_02_0229__l02802a572cd14322a9edb44c392d1063"></a><a name="l02802a572cd14322a9edb44c392d1063"></a>PUT /v1.0/{project_id}/streaming/sql-jobs/{job_id}</p>
</li><li id="dli_02_0229__lab001edff5ca4cde843db03812f0979d">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0229__t219b031199884ac1bb9e91158ddc9efb" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameters</caption><thead align="left"><tr id="dli_02_0229__r04005eeda24e4db9b06516450d4d56af"><th align="left" class="cellrowborder" valign="top" width="15.120000000000001%" id="mcps1.3.2.2.2.1.2.5.1.1"><p id="dli_02_0229__a80847df5e5dc448caa46a2ff258fa2c4">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="11.700000000000001%" id="mcps1.3.2.2.2.1.2.5.1.2"><p id="dli_02_0229__af54fc16087b049c98f748c1a2faace17">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="13.18%" id="mcps1.3.2.2.2.1.2.5.1.3"><p id="dli_02_0229__p886083518157">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.2.2.2.1.2.5.1.4"><p id="dli_02_0229__a484a3e0ce14846799c727ccbd4075d6c">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dli_02_0229__r8022e11be3f54ad290cf8c848a56a550"><td class="cellrowborder" valign="top" width="15.120000000000001%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="dli_02_0229__p1262440203315">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="11.700000000000001%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="dli_02_0229__p1016041415356">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="13.18%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="dli_02_0229__p78602358152">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="dli_02_0229__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_0229__row1266684418111"><td class="cellrowborder" valign="top" width="15.120000000000001%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="dli_02_0229__p12289184791118">job_id</p>
</td>
<td class="cellrowborder" valign="top" width="11.700000000000001%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="dli_02_0229__p112897475113">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="13.18%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="dli_02_0229__p1860113521510">Long</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="dli_02_0229__p128964741114">Job ID. Refer to <a href="dli_02_0228.html">Creating a SQL Job</a> to obtain the value.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="dli_02_0229__s3afece1037ea4f62aeffb3db49b97f70"><h4 class="sectiontitle">Request</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0229__tcedd9d5bece544898da42c15fe855a72" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request parameters</caption><thead align="left"><tr id="dli_02_0229__r263212cfc24b4f7ab11ba179dc95f8d5"><th align="left" class="cellrowborder" valign="top" width="25.06%" id="mcps1.3.3.2.2.5.1.1"><p id="dli_02_0229__aa71bb56aa6ba48488d66e68a44744488">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.940000000000001%" id="mcps1.3.3.2.2.5.1.2"><p id="dli_02_0229__adfb457c202dc4709b315aa6d0a384fdf">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_0229__a07ad11538b854ab4997a0c69b2fa1ff5">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_0229__a27603242143846be8ed4173686b0b27b">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dli_02_0229__rd59ae95756ea47c28d7aa24b2a057881"><td class="cellrowborder" valign="top" width="25.06%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0229__a71daee1cc06048ae818e104254c9166d">name</p>
</td>
<td class="cellrowborder" valign="top" width="14.940000000000001%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0229__p5890154754117">No</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0229__a3b4b1f2ddd81469dbc22dc9de316fc9b">String</p>
</td>
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0229__a4de8fb2d168546a9adf40df6d59ce095">Name of a job. Length range: 0 to 57 characters.</p>
</td>
</tr>
<tr id="dli_02_0229__rc32461e6ae584faebd86e6a27d35ad52"><td class="cellrowborder" valign="top" width="25.06%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0229__a78edaa1801254949b38999fa2b76cb9b">desc</p>
</td>
<td class="cellrowborder" valign="top" width="14.940000000000001%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0229__aa5ebc166527543019d7799ddf643663f">No</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0229__ad6a32cc0ba694cea9fe5f132dd482a0b">String</p>
</td>
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0229__a6311275524c844f4aa133f8f5818d0c0">Job description. Length range: 0 to 512 characters.</p>
</td>
</tr>
<tr id="dli_02_0229__row15798193244110"><td class="cellrowborder" valign="top" width="25.06%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0229__p17928153443914">queue_name</p>
</td>
<td class="cellrowborder" valign="top" width="14.940000000000001%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0229__p89278346396">No</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0229__p1292519344391">String</p>
</td>
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0229__p18919434113920">Name of a queue. The value can contain 0 to 128 characters.</p>
</td>
</tr>
<tr id="dli_02_0229__r38ed7748501049b3a7f15541cb4bdc4b"><td class="cellrowborder" valign="top" width="25.06%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0229__a80f760ee3fc749cda8a968aa352adb03">sql_body</p>
</td>
<td class="cellrowborder" valign="top" width="14.940000000000001%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0229__a340bf6a8cdce459ebdb06f53dd44204d">No</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0229__ab0cf8c891059456883c2149d7b794ba1">String</p>
</td>
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0229__ac9cd898aa62e4b4c81ae3645e8d767e0">Stream SQL statement, which includes at least the following three parts: source, query, and sink. Length range: 0 to 1024x1024 characters.</p>
</td>
</tr>
<tr id="dli_02_0229__r6d6edee93eb44b018bb642182c0e6228"><td class="cellrowborder" valign="top" width="25.06%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0229__aecea9fa299d942e88e78fba90c276a5b">run_mode</p>
</td>
<td class="cellrowborder" valign="top" width="14.940000000000001%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0229__aba11f8fa96ff477e8af2e81aabc0d8de">No</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0229__a1c9f0e6238ad4ce69be9eafbb38d73d9">String</p>
</td>
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0229__p79611213113">Job running mode. The options are as follows:</p>
<ul id="dli_02_0229__ul15289751193715"><li id="dli_02_0229__li109014434020"><strong id="dli_02_0229__b176881152382">shared_cluster</strong>: indicates that the job is running on a shared cluster.</li><li id="dli_02_0229__li10403410212"><strong id="dli_02_0229__b198194161388">exclusive_cluster</strong>: indicates that the job is running on an exclusive cluster.</li><li id="dli_02_0229__li228914518371"><strong id="dli_02_0229__b2098915178386">edge_node</strong>: indicates that the job is running on an edge node.</li></ul>
<p id="dli_02_0229__p12234112771417">The default value is <strong id="dli_02_0229__b1991637104013">shared_cluster</strong>.</p>
</td>
</tr>
<tr id="dli_02_0229__r7661b89ca2e94401ab63183ad079e920"><td class="cellrowborder" valign="top" width="25.06%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0229__a7e069f0f27af4abab440433e570c4763">cu_number</p>
</td>
<td class="cellrowborder" valign="top" width="14.940000000000001%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0229__a4b43c1e99deb4082b3f21179c1477b1f">No</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0229__adf45245d5ce04f61afc160b115d2412b">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0229__p4369141103814">Number of CUs selected for a job. The default value is <strong id="dli_02_0229__b1068913171848">2</strong>.</p>
</td>
</tr>
<tr id="dli_02_0229__r589617809d1e42868f5a1aa6a3dbf196"><td class="cellrowborder" valign="top" width="25.06%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0229__a79683da069714592913a65f1f28389bc">parallel_number</p>
</td>
<td class="cellrowborder" valign="top" width="14.940000000000001%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0229__a3081bb162d8a41cda78080611d26e443">No</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0229__a714864b01e3b4f948edf105756d06630">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0229__a5c667b50c56f47dbb9bee32c10d72ba0">Number of parallel jobs set by a user. The default value is <strong id="dli_02_0229__b84235270615612">1</strong>.</p>
</td>
</tr>
<tr id="dli_02_0229__r4751eede45fe4cb3856249640bbc3c77"><td class="cellrowborder" valign="top" width="25.06%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0229__p686005151439">checkpoint_enabled</p>
</td>
<td class="cellrowborder" valign="top" width="14.940000000000001%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0229__a582fb4ae115d44e79559c249bfcafab6">No</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0229__a32e117ff1f8940e79eb14e009be0e7ab">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0229__p4191338101210">Whether to enable the automatic job snapshot function.</p>
<ul id="dli_02_0229__ul960951941319"><li id="dli_02_0229__li1960812195138"><strong id="dli_02_0229__b978532443113958">true</strong>: indicates to enable the automatic job snapshot function.</li><li id="dli_02_0229__li1660811981313"><strong id="dli_02_0229__b211827064711404">false</strong>: indicates to disable the automatic job snapshot function.</li><li id="dli_02_0229__li1460951901319">Default value: <strong id="dli_02_0229__b75463629211402">false</strong></li></ul>
</td>
</tr>
<tr id="dli_02_0229__rbef8b00389c343f1a6acb6261756d967"><td class="cellrowborder" valign="top" width="25.06%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0229__p32848831151439">checkpoint_mode</p>
</td>
<td class="cellrowborder" valign="top" width="14.940000000000001%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0229__ac3897cc29eb1495b9bbee471c304e326">No</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0229__af4e810f37b724bb4860e63e51fc32e05">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0229__p228619524239">Snapshot mode. There are two options:</p>
<ul id="dli_02_0229__ul133371056182314"><li id="dli_02_0229__li13961658142316"><strong id="dli_02_0229__b4110049112611">1</strong>: <strong id="dli_02_0229__b151161449142617">ExactlyOnce</strong>, indicates that data is processed only once.</li><li id="dli_02_0229__li1433713569235"><strong id="dli_02_0229__b10469451142618">2</strong>: <strong id="dli_02_0229__b74696515263">at_least_once</strong>, indicates that data is processed at least once.</li></ul>
<p id="dli_02_0229__p1972956121218">The default value is <strong id="dli_02_0229__b1825715422613">1</strong>.</p>
</td>
</tr>
<tr id="dli_02_0229__rbdbc4a1a7b9d41b0873a21b5c8c515a4"><td class="cellrowborder" valign="top" width="25.06%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0229__p13880183918268">checkpoint_interval</p>
</td>
<td class="cellrowborder" valign="top" width="14.940000000000001%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0229__p186384642711">No</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0229__p1664216614270">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0229__p5880113952617">Snapshot interval. The unit is second. The default value is <span class="parmvalue" id="dli_02_0229__parmvalue232914488516"><b>10</b></span>.</p>
</td>
</tr>
<tr id="dli_02_0229__r7c856f9629304e7bb100c8794d29caf1"><td class="cellrowborder" valign="top" width="25.06%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0229__p32635548151439">obs_bucket</p>
</td>
<td class="cellrowborder" valign="top" width="14.940000000000001%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0229__af1ba5522fd1e4cb1856c94e5e69a665d">No</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0229__a9a24d2aea7e342e2891e5daf0bf14743">String</p>
</td>
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0229__a1ce1860d24414e2081b94e41c906d4f7">OBS bucket where users are authorized to save the snapshot. This parameter is valid only when <span class="parmname" id="dli_02_0229__parmname17432131119309"><b>checkpoint_enabled</b></span> is set to <strong id="dli_02_0229__b1943281120306">true</strong>.</p>
<p id="dli_02_0229__p18511124216591">OBS bucket where users are authorized to save the snapshot. This parameter is valid only when <strong id="dli_02_0229__b0622201512307">log_enabled</strong> is set to <strong id="dli_02_0229__b76221315193013">true</strong>.</p>
</td>
</tr>
<tr id="dli_02_0229__row13972369443"><td class="cellrowborder" valign="top" width="25.06%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0229__p29331592151433">log_enabled</p>
</td>
<td class="cellrowborder" valign="top" width="14.940000000000001%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0229__a01071703297a4354bb6cb18ba6572f3f">No</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0229__a279c155d38614fc486c897f82f6a3a8f">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0229__a8819ccc464094137afa687b48d8f62b2">Whether to enable the function of uploading job logs to users' OBS buckets. The default value is <span class="parmvalue" id="dli_02_0229__parmvalue18333947602"><b>false</b></span>.</p>
</td>
</tr>
<tr id="dli_02_0229__row133265345358"><td class="cellrowborder" valign="top" width="25.06%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0229__p27391449182012">smn_topic</p>
</td>
<td class="cellrowborder" valign="top" width="14.940000000000001%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0229__p1773919491205">No</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0229__p147398499204">String</p>
</td>
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0229__p67391449142016">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_0229__row153621144471"><td class="cellrowborder" valign="top" width="25.06%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0229__p12884615665">restart_when_exception</p>
</td>
<td class="cellrowborder" valign="top" width="14.940000000000001%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0229__p1414410363514">No</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0229__p1714403618511">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0229__p314419367515">Whether to enable the function of automatically restarting a job upon job exceptions. The default value is <span class="parmvalue" id="dli_02_0229__parmvalue52961551300"><b>false</b></span>.</p>
</td>
</tr>
<tr id="dli_02_0229__row25271748175"><td class="cellrowborder" valign="top" width="25.06%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0229__p1888312819610">idle_state_retention</p>
</td>
<td class="cellrowborder" valign="top" width="14.940000000000001%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0229__p21931256755">No</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0229__p1119385615510">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0229__p15193856757">Expiration time, in seconds. The default value is <strong id="dli_02_0229__b156265352719">3600</strong>.</p>
</td>
</tr>
<tr id="dli_02_0229__row240012396412"><td class="cellrowborder" valign="top" width="25.06%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0229__p12217143121118">edge_group_ids</p>
</td>
<td class="cellrowborder" valign="top" width="14.940000000000001%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0229__p1721753113116">No</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0229__p1921773141113">Array of Strings</p>
</td>
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0229__p19919221166">List of edge computing group IDs. Use commas (,) to separate multiple IDs.</p>
</td>
</tr>
<tr id="dli_02_0229__row61241615163812"><td class="cellrowborder" valign="top" width="25.06%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0229__p1842823984611">dirty_data_strategy</p>
</td>
<td class="cellrowborder" valign="top" width="14.940000000000001%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0229__p164285395469">No</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0229__p94281539184614">String</p>
</td>
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0229__p1842883912463">Dirty data policy of a job.</p>
<ul id="dli_02_0229__ul14821163115417"><li id="dli_02_0229__li1182114311541"><strong id="dli_02_0229__b17965124217515">2:obsDir</strong>: Save. <strong id="dli_02_0229__b1396644205118">obsDir</strong> specifies the path for storing dirty data.</li><li id="dli_02_0229__li19342046105619"><strong id="dli_02_0229__b4835164405118">1</strong>: Trigger a job exception</li><li id="dli_02_0229__li1891112118577"><strong id="dli_02_0229__b78624463513">0</strong>: Ignore</li></ul>
<p id="dli_02_0229__p17304143102218">The default value is <strong id="dli_02_0229__b1112194194213">0</strong>.</p>
</td>
</tr>
<tr id="dli_02_0229__row9273944104119"><td class="cellrowborder" valign="top" width="25.06%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0229__p19470241751">udf_jar_url</p>
</td>
<td class="cellrowborder" valign="top" width="14.940000000000001%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0229__p19474241851">No</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0229__p1894820241519">String</p>
</td>
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0229__p894882416512">Name of the resource package that has been uploaded to the DLI resource management system. The UDF Jar file of the SQL job is specified by this parameter.</p>
</td>
</tr>
<tr id="dli_02_0229__row1665234414101"><td class="cellrowborder" valign="top" width="25.06%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0229__p1841414505107">manager_cu_number</p>
</td>
<td class="cellrowborder" valign="top" width="14.940000000000001%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0229__p1441435061018">No</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0229__p141575071016">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0229__p9415145081017">Number of CUs in the JobManager selected for a job. The default value is <strong id="dli_02_0229__b101435193912">1</strong>.</p>
</td>
</tr>
<tr id="dli_02_0229__row1016815010417"><td class="cellrowborder" valign="top" width="25.06%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0229__p62741531828">tm_cus</p>
</td>
<td class="cellrowborder" valign="top" width="14.940000000000001%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0229__p1827415533218">No</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0229__p132740531925">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0229__p9274165315217">Number of CUs for each TaskManager. The default value is <strong id="dli_02_0229__b46285517394">1</strong>.</p>
</td>
</tr>
<tr id="dli_02_0229__row101673018413"><td class="cellrowborder" valign="top" width="25.06%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0229__p122748531625">tm_slot_num</p>
</td>
<td class="cellrowborder" valign="top" width="14.940000000000001%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0229__p1274125315210">No</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0229__p1327455313218">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0229__p4275145317210">Number of slots in each TaskManager. The default value is <strong id="dli_02_0229__b1531595811398">(parallel_number*tm_cus)/(cu_number-manager_cu_number)</strong>.</p>
</td>
</tr>
<tr id="dli_02_0229__row255289141416"><td class="cellrowborder" valign="top" width="25.06%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0229__p455329181418">operator_config</p>
</td>
<td class="cellrowborder" valign="top" width="14.940000000000001%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0229__p25531093140">No</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0229__p10553129141411">String</p>
</td>
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0229__p855316917148">Degree of parallelism (DOP) of an operator.</p>
</td>
</tr>
<tr id="dli_02_0229__row16531919152715"><td class="cellrowborder" valign="top" width="25.06%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0229__p2335124251810">resume_checkpoint</p>
</td>
<td class="cellrowborder" valign="top" width="14.940000000000001%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0229__p173354422187">No</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0229__p113357429186">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0229__p233519428187">Whether the abnormal restart is recovered from the checkpoint.</p>
</td>
</tr>
<tr id="dli_02_0229__row145301819172713"><td class="cellrowborder" valign="top" width="25.06%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0229__p3543245162311">resume_max_num</p>
</td>
<td class="cellrowborder" valign="top" width="14.940000000000001%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0229__p9541245182312">No</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0229__p185409459238">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0229__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_0229__b14885516344">-1</strong>, indicating that the number of times is unlimited.</p>
</td>
</tr>
<tr id="dli_02_0229__row23271527124812"><td class="cellrowborder" valign="top" width="25.06%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0229__p432792704815">static_estimator_config</p>
</td>
<td class="cellrowborder" valign="top" width="14.940000000000001%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0229__p1432702717489">No</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0229__p12327182716481">String</p>
</td>
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0229__p1732815276486">Traffic or hit ratio of each operator, which is a string in JSON format. Example:</p>
<pre class="screen" id="dli_02_0229__screen113231649135711">{"operator_list":[{"id":"0a448493b4782967b150582570326227","rate_factor":0.55},{"id":"6d2677a0ecc3fd8df0b72ec675edf8f4","rate_factor":1},{"id":"ea632d67b7d595e5b851708ae9ad79d6","rate_factor":0.55},{"id":"bc764cd8ddf7a0cff126f51c16239658","output_rate":2000}]}</pre>
</td>
</tr>
<tr id="dli_02_0229__row153693415915"><td class="cellrowborder" valign="top" width="25.06%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0229__p95362034690">runtime_config</p>
</td>
<td class="cellrowborder" valign="top" width="14.940000000000001%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0229__p165376345912">No</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0229__p25373349919">String</p>
</td>
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0229__p1153712346915">Customizes optimization parameters when a Flink job is running.</p>
</td>
</tr>
<tr id="dli_02_0229__row153265426342"><td class="cellrowborder" valign="top" width="25.06%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0229__p151566375316">flink_version</p>
</td>
<td class="cellrowborder" valign="top" width="14.940000000000001%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0229__p11156633539">No</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0229__p171568315310">String</p>
</td>
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0229__p1815673185311">Flink version. Currently, only 1.10 and 1.12 are supported.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="dli_02_0229__se2bf80cdb76541308f69f258ea4b1bd6"><h4 class="sectiontitle">Response</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0229__table864065813431" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response parameters</caption><thead align="left"><tr id="dli_02_0229__row17641185813437"><th align="left" class="cellrowborder" valign="top" width="16.439999999999998%" id="mcps1.3.4.2.2.5.1.1"><p id="dli_02_0229__p1164195820435">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="12.46%" id="mcps1.3.4.2.2.5.1.2"><p id="dli_02_0229__p66412588434">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20.49%" id="mcps1.3.4.2.2.5.1.3"><p id="dli_02_0229__p9641458194311">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50.61%" id="mcps1.3.4.2.2.5.1.4"><p id="dli_02_0229__p186411358194312">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dli_02_0229__row2418154742"><td class="cellrowborder" valign="top" width="16.439999999999998%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0229__p10253165219311">is_success</p>
</td>
<td class="cellrowborder" valign="top" width="12.46%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0229__p8253115273111">No</p>
</td>
<td class="cellrowborder" valign="top" width="20.49%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0229__p7253352153116">String</p>
</td>
<td class="cellrowborder" valign="top" width="50.61%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0229__p8253152103110">Indicates whether the request is successfully executed. Value <span class="parmvalue" id="dli_02_0229__parmvalue69794854319"><b>true</b></span> indicates that the request is successfully executed.</p>
</td>
</tr>
<tr id="dli_02_0229__row64180541741"><td class="cellrowborder" valign="top" width="16.439999999999998%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0229__p17641165884319">message</p>
</td>
<td class="cellrowborder" valign="top" width="12.46%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0229__p1064295812435">No</p>
</td>
<td class="cellrowborder" valign="top" width="20.49%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0229__p4642058174318">String</p>
</td>
<td class="cellrowborder" valign="top" width="50.61%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0229__p146421758194310">Message content.</p>
</td>
</tr>
<tr id="dli_02_0229__row13575616163215"><td class="cellrowborder" valign="top" width="16.439999999999998%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0229__p1457691643219">job</p>
</td>
<td class="cellrowborder" valign="top" width="12.46%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0229__p3576151610328">No</p>
</td>
<td class="cellrowborder" valign="top" width="20.49%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0229__p5576316153211">Object</p>
</td>
<td class="cellrowborder" valign="top" width="50.61%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0229__p15761162327">Information about job update. For details, see <a href="#dli_02_0229__table128621016345">Table 4</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="dli_02_0229__table128621016345"></a><a name="table128621016345"></a><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0229__table128621016345" frame="border" border="1" rules="all"><caption><b>Table 4 </b>job parameter</caption><thead align="left"><tr id="dli_02_0229__row88741014347"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.3.2.5.1.1"><p id="dli_02_0229__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_0229__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_0229__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_0229__p1788151013347">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dli_02_0229__row2090131017345"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dli_02_0229__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_0229__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_0229__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_0229__p59012101344">Job update time, expressed by milliseconds</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="dli_02_0229__section1130754105710"><h4 class="sectiontitle">Example Request</h4><p id="dli_02_0229__p29451725314">Update an existing SQL job. The updated job is named <strong id="dli_02_0229__b697925213341">myjob</strong> and runs on <strong id="dli_02_0229__b63106499362">testQueue</strong> in shared mode.</p>
<pre class="screen" id="dli_02_0229__sabcf8723ba2d4d3c912b17feda88f427">{
"name": "myjob",
"desc": "My first job",
"queue_name": "testQueue",
"sql_body": "select * from source_table",
"run_mode": "shared_cluster",
"cu_number": 4,
"parallel_number": 4,
"checkpoint_enabled": false,
"checkpoint_mode": "exactly_once",
"checkpoint_interval": 10,
"obs_bucket": "",
"log_enabled": false,
"smn_topic": "",
"restart_when_exception": false,
"idle_state_retention": 3600,
"edge_group_ids": [
"62de1e1c-066e-48a8-a79d-f461a31b2ee1",
"2eb00f85-99f2-4144-bcb7-d39ff47f9002"
],
"dirty_data_strategy": "0",
"udf_jar_url": "group/test.jar"
}</pre>
</div>
<div class="section" id="dli_02_0229__section1141183661614"><h4 class="sectiontitle">Example Response</h4><pre class="screen" id="dli_02_0229__s6d0d234a671f4e618d1a2b5e746cff26">{
"is_success": "true",
"message": "The job is updated successfully.",
"job": {
"update_time": 1578905682534
}
}</pre>
</div>
<div class="section" id="dli_02_0229__s1b495ba11cd9411c9ad2ee50103334a7"><h4 class="sectiontitle">Status Codes</h4><p id="dli_02_0229__acef1445366354016b2ed90921927a555"><a href="#dli_02_0229__t43c1f1c0ba344f4cbcb270953d9cca2a">Table 5</a> describes status codes.</p>
<div class="tablenoborder"><a name="dli_02_0229__t43c1f1c0ba344f4cbcb270953d9cca2a"></a><a name="t43c1f1c0ba344f4cbcb270953d9cca2a"></a><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0229__t43c1f1c0ba344f4cbcb270953d9cca2a" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Status codes</caption><thead align="left"><tr id="dli_02_0229__r2ad0f008ce2248a1800a3e8b77226a56"><th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.7.3.2.3.1.1"><p id="dli_02_0229__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_0229__af801170b350b4f8ba3b575c7ddb8b13e">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dli_02_0229__r0b449b1d3b8c498ea3e6cce16c80a14c"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.7.3.2.3.1.1 "><p id="dli_02_0229__a8c63a97e3bad402ebaead0bd99cad632">200</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.7.3.2.3.1.2 "><p id="dli_02_0229__af86844c7bb364c48b6300df1af164af2">The job is updated successfully.</p>
</td>
</tr>
<tr id="dli_02_0229__row642813610440"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.7.3.2.3.1.1 "><p id="dli_02_0229__p104285674412">400</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.7.3.2.3.1.2 "><p id="dli_02_0229__p154287617445">The input parameter is invalid.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="dli_02_0229__section13596141025715"><h4 class="sectiontitle">Error Codes</h4><p id="dli_02_0229__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