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

439 lines
33 KiB
HTML
Raw Blame History

<a name="dli_02_0230"></a><a name="dli_02_0230"></a>
<h1 class="topictitle1">Creating a Flink Jar job</h1>
<div id="body1574749525454"><div class="section" id="dli_02_0230__s89ff8bc59cba4c3b94dc17e85c8fa1ea"><h4 class="sectiontitle">Function</h4><p id="dli_02_0230__p136364272588">This API is used to create custom jobs, which currently support the JAR format and run in dedicated queues.</p>
</div>
<div class="section" id="dli_02_0230__sef21e3efc2a44a84a03adad33a1ae006"><h4 class="sectiontitle">URI</h4><ul id="dli_02_0230__uf99c5b2f64a44669a611cae56296b336"><li id="dli_02_0230__l02802a572cd14322a9edb44c392d1063">URI format<p id="dli_02_0230__ab9f59a1049d24cb2a9c51b9ed06e59d4"><a name="dli_02_0230__l02802a572cd14322a9edb44c392d1063"></a><a name="l02802a572cd14322a9edb44c392d1063"></a>POST /v1.0/{project_id}/streaming/flink-jobs</p>
</li><li id="dli_02_0230__lab001edff5ca4cde843db03812f0979d">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0230__t219b031199884ac1bb9e91158ddc9efb" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameter</caption><thead align="left"><tr id="dli_02_0230__r04005eeda24e4db9b06516450d4d56af"><th align="left" class="cellrowborder" valign="top" width="16.82%" id="mcps1.3.2.2.2.1.2.5.1.1"><p id="dli_02_0230__a80847df5e5dc448caa46a2ff258fa2c4">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="12.2%" id="mcps1.3.2.2.2.1.2.5.1.2"><p id="dli_02_0230__af54fc16087b049c98f748c1a2faace17">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="10.42%" id="mcps1.3.2.2.2.1.2.5.1.3"><p id="dli_02_0230__p138331863114">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60.56%" id="mcps1.3.2.2.2.1.2.5.1.4"><p id="dli_02_0230__a484a3e0ce14846799c727ccbd4075d6c">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dli_02_0230__r8022e11be3f54ad290cf8c848a56a550"><td class="cellrowborder" valign="top" width="16.82%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="dli_02_0230__p1262440203315">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="12.2%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="dli_02_0230__p1016041415356">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="10.42%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="dli_02_0230__p14833188133115">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.56%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="dli_02_0230__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_0230__s3afece1037ea4f62aeffb3db49b97f70"><h4 class="sectiontitle">Request</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0230__table167338273210" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="dli_02_0230__row473492772112"><th align="left" class="cellrowborder" valign="top" width="24.349999999999998%" id="mcps1.3.3.2.2.5.1.1"><p id="dli_02_0230__p1473442722114">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="11.83%" id="mcps1.3.3.2.2.5.1.2"><p id="dli_02_0230__p924151853112">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="12.049999999999999%" id="mcps1.3.3.2.2.5.1.3"><p id="dli_02_0230__p137119461396">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="51.77%" id="mcps1.3.3.2.2.5.1.4"><p id="dli_02_0230__p1873432716213">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dli_02_0230__row137341727132113"><td class="cellrowborder" valign="top" width="24.349999999999998%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0230__p6734122720213">name</p>
</td>
<td class="cellrowborder" valign="top" width="11.83%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0230__p16241141810311">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="12.049999999999999%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0230__p394123011411">String</p>
</td>
<td class="cellrowborder" valign="top" width="51.77%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0230__p12734427152118">Name of the job. The value can contain 1 to 57 characters.</p>
</td>
</tr>
<tr id="dli_02_0230__row157341727112111"><td class="cellrowborder" valign="top" width="24.349999999999998%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0230__p37343278217">desc</p>
</td>
<td class="cellrowborder" valign="top" width="11.83%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0230__p16241121816313">No</p>
</td>
<td class="cellrowborder" valign="top" width="12.049999999999999%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0230__p134186214816">String</p>
</td>
<td class="cellrowborder" valign="top" width="51.77%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0230__p207341827192110">Job description. Length range: 0 to 512 characters.</p>
</td>
</tr>
<tr id="dli_02_0230__row668327131518"><td class="cellrowborder" valign="top" width="24.349999999999998%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0230__p621523961515">queue_name</p>
</td>
<td class="cellrowborder" valign="top" width="11.83%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0230__p1721515390153">No</p>
</td>
<td class="cellrowborder" valign="top" width="12.049999999999999%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0230__p82151339141519">String</p>
</td>
<td class="cellrowborder" valign="top" width="51.77%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0230__p821553918157">Name of a queue. The value can contain 0 to 128 characters.</p>
</td>
</tr>
<tr id="dli_02_0230__row573417279212"><td class="cellrowborder" valign="top" width="24.349999999999998%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0230__p1773410271210">cu_number</p>
</td>
<td class="cellrowborder" valign="top" width="11.83%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0230__p1524121873112">No</p>
</td>
<td class="cellrowborder" valign="top" width="12.049999999999999%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0230__p191902533811">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="51.77%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0230__p157341327112113">Number of CUs selected for a job.</p>
</td>
</tr>
<tr id="dli_02_0230__row8381047124211"><td class="cellrowborder" valign="top" width="24.349999999999998%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0230__p3942456173617">manager_cu_number</p>
</td>
<td class="cellrowborder" valign="top" width="11.83%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0230__p1494215615362">No</p>
</td>
<td class="cellrowborder" valign="top" width="12.049999999999999%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0230__p3942135673612">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="51.77%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0230__p29421456113614">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_0230__b93301116194019">1</strong>.</p>
</td>
</tr>
<tr id="dli_02_0230__row873413275210"><td class="cellrowborder" valign="top" width="24.349999999999998%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0230__p978704819454">parallel_number</p>
</td>
<td class="cellrowborder" valign="top" width="11.83%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0230__p12439184316">No</p>
</td>
<td class="cellrowborder" valign="top" width="12.049999999999999%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0230__p14728172409">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="51.77%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0230__p15964644992">Number of parallel operations selected for a job.</p>
</td>
</tr>
<tr id="dli_02_0230__row1679750142215"><td class="cellrowborder" valign="top" width="24.349999999999998%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0230__p19797100225">log_enabled</p>
</td>
<td class="cellrowborder" valign="top" width="11.83%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0230__p1124310189313">No</p>
</td>
<td class="cellrowborder" valign="top" width="12.049999999999999%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0230__p585014405335">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="51.77%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0230__p201891638534">Whether to enable the job log function.</p>
<ul id="dli_02_0230__ul960951941319"><li id="dli_02_0230__li1960812195138"><strong id="dli_02_0230__b842352706175435">true</strong>: indicates to enable the job log function.</li><li id="dli_02_0230__li1660811981313"><strong id="dli_02_0230__b583984342103443">false</strong>: indicates to disable the job log function.</li><li id="dli_02_0230__li1460951901319">Default value: <strong id="dli_02_0230__b75463629211402">false</strong></li></ul>
</td>
</tr>
<tr id="dli_02_0230__row5797130182213"><td class="cellrowborder" valign="top" width="24.349999999999998%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0230__p127987013227">obs_bucket</p>
</td>
<td class="cellrowborder" valign="top" width="11.83%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0230__p10243181816311">No</p>
</td>
<td class="cellrowborder" valign="top" width="12.049999999999999%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0230__p244659164112">String</p>
</td>
<td class="cellrowborder" valign="top" width="51.77%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0230__p14798100122220">OBS bucket where users are authorized to save logs when <strong id="dli_02_0230__b84235270614412">log_enabled</strong> is set to <strong id="dli_02_0230__b84235270614419">true</strong>.</p>
</td>
</tr>
<tr id="dli_02_0230__row16913193319413"><td class="cellrowborder" valign="top" width="24.349999999999998%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0230__p391319334411">smn_topic</p>
</td>
<td class="cellrowborder" valign="top" width="11.83%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0230__p152434182319">No</p>
</td>
<td class="cellrowborder" valign="top" width="12.049999999999999%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0230__p285034019338">String</p>
</td>
<td class="cellrowborder" valign="top" width="51.77%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0230__p1491312333417">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_0230__row1667713917350"><td class="cellrowborder" valign="top" width="24.349999999999998%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0230__p1767811915356">main_class</p>
</td>
<td class="cellrowborder" valign="top" width="11.83%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0230__p1524331818315">No</p>
</td>
<td class="cellrowborder" valign="top" width="12.049999999999999%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0230__p18966151111382">String</p>
</td>
<td class="cellrowborder" valign="top" width="51.77%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0230__p867818923519">Job entry class.</p>
</td>
</tr>
<tr id="dli_02_0230__row1567815917356"><td class="cellrowborder" valign="top" width="24.349999999999998%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0230__p1067811920359">entrypoint_args</p>
</td>
<td class="cellrowborder" valign="top" width="11.83%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0230__p92431918103111">No</p>
</td>
<td class="cellrowborder" valign="top" width="12.049999999999999%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0230__p1696618119384">String</p>
</td>
<td class="cellrowborder" valign="top" width="51.77%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0230__p1367814923518">Job entry parameter. Multiple parameters are separated by spaces.</p>
</td>
</tr>
<tr id="dli_02_0230__row181283543917"><td class="cellrowborder" valign="top" width="24.349999999999998%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0230__p8559173762410">restart_when_exception</p>
</td>
<td class="cellrowborder" valign="top" width="11.83%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0230__p256063714247">No</p>
</td>
<td class="cellrowborder" valign="top" width="12.049999999999999%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0230__p84861029174011">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="51.77%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0230__p85601437192419">Whether to enable the function of restart upon exceptions. The default value is <strong id="dli_02_0230__b092765917503">false</strong>.</p>
</td>
</tr>
<tr id="dli_02_0230__row48781249517"><td class="cellrowborder" valign="top" width="24.349999999999998%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0230__p8948157185118">entrypoint</p>
</td>
<td class="cellrowborder" valign="top" width="11.83%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0230__p119484755116">No</p>
</td>
<td class="cellrowborder" valign="top" width="12.049999999999999%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0230__p49487710511">String</p>
</td>
<td class="cellrowborder" valign="top" width="51.77%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0230__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_0230__row1823375616469"><td class="cellrowborder" valign="top" width="24.349999999999998%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0230__p7233155624618">dependency_jars</p>
</td>
<td class="cellrowborder" valign="top" width="11.83%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0230__p42331956124615">No</p>
</td>
<td class="cellrowborder" valign="top" width="12.049999999999999%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0230__p9233155654619">Array of Strings</p>
</td>
<td class="cellrowborder" valign="top" width="51.77%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0230__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_0230__p19536182203415">Example: <strong id="dli_02_0230__b11162164045118">myGroup/test.jar,myGroup/test1.jar</strong>.</p>
</td>
</tr>
<tr id="dli_02_0230__row17488175413010"><td class="cellrowborder" valign="top" width="24.349999999999998%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0230__p174899543309">dependency_files</p>
</td>
<td class="cellrowborder" valign="top" width="11.83%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0230__p1548919541305">No</p>
</td>
<td class="cellrowborder" valign="top" width="12.049999999999999%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0230__p748975419303">Array of Strings</p>
</td>
<td class="cellrowborder" valign="top" width="51.77%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0230__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_0230__p948945412308">Example: <strong id="dli_02_0230__b20357142711915">myGroup/test.cvs,myGroup/test1.csv</strong>.</p>
<p id="dli_02_0230__p12932165261213">You can add the following content to the application to access the corresponding dependency file: In the command, <span class="parmname" id="dli_02_0230__parmname15813163719193"><b>fileName</b></span> indicates the name of the file to be accessed, and <span class="parmname" id="dli_02_0230__parmname181818376199"><b>ClassName</b></span> indicates the name of the class that needs to access the file.</p>
<pre class="screen" id="dli_02_0230__screen43817144438">ClassName.class.getClassLoader().getResource("userData/fileName")</pre>
</td>
</tr>
<tr id="dli_02_0230__row1427415315216"><td class="cellrowborder" valign="top" width="24.349999999999998%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0230__p62741531828">tm_cus</p>
</td>
<td class="cellrowborder" valign="top" width="11.83%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0230__p1827415533218">No</p>
</td>
<td class="cellrowborder" valign="top" width="12.049999999999999%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0230__p132740531925">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="51.77%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0230__p9274165315217">Number of CUs for each TaskManager. The default value is <strong id="dli_02_0230__b186091426194017">1</strong>.</p>
</td>
</tr>
<tr id="dli_02_0230__row15274853229"><td class="cellrowborder" valign="top" width="24.349999999999998%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0230__p122748531625">tm_slot_num</p>
</td>
<td class="cellrowborder" valign="top" width="11.83%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0230__p1274125315210">No</p>
</td>
<td class="cellrowborder" valign="top" width="12.049999999999999%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0230__p1327455313218">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="51.77%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0230__p4275145317210">Number of slots in each TaskManager. The default value is <strong id="dli_02_0230__b851972916407">(parallel_number*tm_cus)/(cu_number-manager_cu_number)</strong>.</p>
</td>
</tr>
<tr id="dli_02_0230__row8139104392613"><td class="cellrowborder" valign="top" width="24.349999999999998%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0230__p2335124251810">resume_checkpoint</p>
</td>
<td class="cellrowborder" valign="top" width="11.83%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0230__p173354422187">No</p>
</td>
<td class="cellrowborder" valign="top" width="12.049999999999999%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0230__p113357429186">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="51.77%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0230__p233519428187">Whether the abnormal restart is recovered from the checkpoint.</p>
</td>
</tr>
<tr id="dli_02_0230__row7137124342615"><td class="cellrowborder" valign="top" width="24.349999999999998%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0230__p3543245162311">resume_max_num</p>
</td>
<td class="cellrowborder" valign="top" width="11.83%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0230__p9541245182312">No</p>
</td>
<td class="cellrowborder" valign="top" width="12.049999999999999%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0230__p185409459238">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="51.77%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0230__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_0230__b13333111134119">-1</strong>, indicating that the number of times is unlimited.</p>
</td>
</tr>
<tr id="dli_02_0230__row91351143152614"><td class="cellrowborder" valign="top" width="24.349999999999998%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0230__p1336124261814">checkpoint_path</p>
</td>
<td class="cellrowborder" valign="top" width="11.83%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0230__p153361942171813">No</p>
</td>
<td class="cellrowborder" valign="top" width="12.049999999999999%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0230__p73361242191816">String</p>
</td>
<td class="cellrowborder" valign="top" width="51.77%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0230__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_0230__row11947101815413"><td class="cellrowborder" valign="top" width="24.349999999999998%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0230__p912055285516">tags</p>
</td>
<td class="cellrowborder" valign="top" width="11.83%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0230__p712010527557">No</p>
</td>
<td class="cellrowborder" valign="top" width="12.049999999999999%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0230__p13120195215519">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="51.77%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0230__p10120125235516">Label of a Flink JAR job. For details, see <a href="#dli_02_0230__table9391124139">Table 3</a>.</p>
</td>
</tr>
<tr id="dli_02_0230__row3617637115710"><td class="cellrowborder" valign="top" width="24.349999999999998%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0230__p95362034690">runtime_config</p>
</td>
<td class="cellrowborder" valign="top" width="11.83%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0230__p165376345912">No</p>
</td>
<td class="cellrowborder" valign="top" width="12.049999999999999%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0230__p25373349919">String</p>
</td>
<td class="cellrowborder" valign="top" width="51.77%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0230__p1153712346915">Customizes optimization parameters when a Flink job is running.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="dli_02_0230__table9391124139"></a><a name="table9391124139"></a><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0230__table9391124139" frame="border" border="1" rules="all"><caption><b>Table 3 </b>tags parameter</caption><thead align="left"><tr id="dli_02_0230__row1440020130"><th align="left" class="cellrowborder" valign="top" width="14.899999999999999%" id="mcps1.3.3.3.2.5.1.1"><p id="dli_02_0230__p194012219139">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="10.82%" id="mcps1.3.3.3.2.5.1.2"><p id="dli_02_0230__p540724136">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.48%" id="mcps1.3.3.3.2.5.1.3"><p id="dli_02_0230__p840162161315">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="57.8%" id="mcps1.3.3.3.2.5.1.4"><p id="dli_02_0230__p16401271318">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dli_02_0230__row194013231317"><td class="cellrowborder" valign="top" width="14.899999999999999%" headers="mcps1.3.3.3.2.5.1.1 "><p id="dli_02_0230__p13401329138">key</p>
</td>
<td class="cellrowborder" valign="top" width="10.82%" headers="mcps1.3.3.3.2.5.1.2 "><p id="dli_02_0230__p940102141313">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="16.48%" headers="mcps1.3.3.3.2.5.1.3 "><p id="dli_02_0230__p64019231317">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.8%" headers="mcps1.3.3.3.2.5.1.4 "><p id="dli_02_0230__p5401021139">Tag key.</p>
<div class="note" id="dli_02_0230__note0301141034716"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="dli_02_0230__p103021210124719">A tag key can contain a maximum of 36 characters. Special characters (=*&lt;&gt;\|) are not allowed, and the key cannot start with a space.</p>
</div></div>
<div class="note" id="dli_02_0230__note17482201612452"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="dli_02_0230__p16482171618455">A tag key can contain a maximum of 128 characters. Only letters, digits, spaces, and special characters (_.:=+-@) are allowed, but the value cannot start or end with a space or start with <strong id="dli_02_0230__b63737541511">_sys_</strong>.</p>
</div></div>
</td>
</tr>
<tr id="dli_02_0230__row1141142181320"><td class="cellrowborder" valign="top" width="14.899999999999999%" headers="mcps1.3.3.3.2.5.1.1 "><p id="dli_02_0230__p164118215134">value</p>
</td>
<td class="cellrowborder" valign="top" width="10.82%" headers="mcps1.3.3.3.2.5.1.2 "><p id="dli_02_0230__p1141112181317">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="16.48%" headers="mcps1.3.3.3.2.5.1.3 "><p id="dli_02_0230__p174114281318">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.8%" headers="mcps1.3.3.3.2.5.1.4 "><p id="dli_02_0230__p16411125137">Tag key.</p>
<div class="note" id="dli_02_0230__note1889312310474"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="dli_02_0230__p1789316312479">A tag value can contain a maximum of 43 characters. Special characters (=*&lt;&gt;\|) are not allowed, and the value cannot start with a space.</p>
</div></div>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="dli_02_0230__se2bf80cdb76541308f69f258ea4b1bd6"><h4 class="sectiontitle">Response</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0230__t5995d65f65ba4ebca8606202112b407e" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response parameters</caption><thead align="left"><tr id="dli_02_0230__ra7acea51e4b4437e917d21fe99f130a3"><th align="left" class="cellrowborder" valign="top" width="19.25%" id="mcps1.3.4.2.2.5.1.1"><p id="dli_02_0230__a5af940f2267747ef871c67c86a0be82e">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.44%" id="mcps1.3.4.2.2.5.1.2"><p id="dli_02_0230__abcfbd3a651704d539626f3a41cc744f5">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="13.370000000000001%" id="mcps1.3.4.2.2.5.1.3"><p id="dli_02_0230__a2351d8d266444ad3ad1c09540d6d81cc">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="52.94%" id="mcps1.3.4.2.2.5.1.4"><p id="dli_02_0230__af7ea6a3f59844bdf99d51e90d570be4c">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dli_02_0230__row2418154742"><td class="cellrowborder" valign="top" width="19.25%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0230__p2827183519">is_success</p>
</td>
<td class="cellrowborder" valign="top" width="14.44%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0230__p6362111364911">No</p>
</td>
<td class="cellrowborder" valign="top" width="13.370000000000001%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0230__p118601817517">String</p>
</td>
<td class="cellrowborder" valign="top" width="52.94%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0230__p1487318359">Indicates whether the request is successfully executed. Value <span class="parmvalue" id="dli_02_0230__parmvalue3565124345319"><b>true</b></span> indicates that the request is successfully executed.</p>
</td>
</tr>
<tr id="dli_02_0230__row64180541741"><td class="cellrowborder" valign="top" width="19.25%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0230__a4aba020b918e457a8a3d15e7ebaeb20d">message</p>
</td>
<td class="cellrowborder" valign="top" width="14.44%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0230__p11374111319494">No</p>
</td>
<td class="cellrowborder" valign="top" width="13.370000000000001%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0230__ac85edc0a27d044b0ad524a4124e59e4c">String</p>
</td>
<td class="cellrowborder" valign="top" width="52.94%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0230__ac087aec9dfcc407ba244ad3e96b23257">Message content.</p>
</td>
</tr>
<tr id="dli_02_0230__row15874961669"><td class="cellrowborder" valign="top" width="19.25%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0230__p933863862615">job</p>
</td>
<td class="cellrowborder" valign="top" width="14.44%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0230__p9338638122617">No</p>
</td>
<td class="cellrowborder" valign="top" width="13.370000000000001%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0230__p33383387265">Object</p>
</td>
<td class="cellrowborder" valign="top" width="52.94%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0230__p18338103822617">Information about the job status. For details, see <a href="#dli_02_0230__table86492245453">Table 5</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="dli_02_0230__table86492245453"></a><a name="table86492245453"></a><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0230__table86492245453" frame="border" border="1" rules="all"><caption><b>Table 5 </b><strong id="dli_02_0230__b75661650115320">job</strong> parameters</caption><thead align="left"><tr id="dli_02_0230__row176501524184518"><th align="left" class="cellrowborder" valign="top" width="19.25%" id="mcps1.3.4.3.2.5.1.1"><p id="dli_02_0230__p18650152414511">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.44%" id="mcps1.3.4.3.2.5.1.2"><p id="dli_02_0230__p10650424204518">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="13.370000000000001%" id="mcps1.3.4.3.2.5.1.3"><p id="dli_02_0230__p865022420455">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="52.94%" id="mcps1.3.4.3.2.5.1.4"><p id="dli_02_0230__p10650192416454">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dli_02_0230__row1965211245455"><td class="cellrowborder" valign="top" width="19.25%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dli_02_0230__p265214241459">job_id</p>
</td>
<td class="cellrowborder" valign="top" width="14.44%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0230__p176521824104518">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="13.370000000000001%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0230__p965292416455">Long</p>
</td>
<td class="cellrowborder" valign="top" width="52.94%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0230__p26525248455">Job ID.</p>
</td>
</tr>
<tr id="dli_02_0230__row1465210242456"><td class="cellrowborder" valign="top" width="19.25%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dli_02_0230__p1465252404513">status_name</p>
</td>
<td class="cellrowborder" valign="top" width="14.44%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0230__p8652624134510">No</p>
</td>
<td class="cellrowborder" valign="top" width="13.370000000000001%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0230__p665282413457">String</p>
</td>
<td class="cellrowborder" valign="top" width="52.94%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0230__p156531124134510">Name of job status.</p>
</td>
</tr>
<tr id="dli_02_0230__row1865352464519"><td class="cellrowborder" valign="top" width="19.25%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dli_02_0230__p1665314248452">status_desc</p>
</td>
<td class="cellrowborder" valign="top" width="14.44%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0230__p15653122464517">No</p>
</td>
<td class="cellrowborder" valign="top" width="13.370000000000001%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0230__p14653024114510">String</p>
</td>
<td class="cellrowborder" valign="top" width="52.94%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0230__p565313246452">Status description. Causes and suggestions for the abnormal status.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="dli_02_0230__section1130754105710"><h4 class="sectiontitle">Example Request</h4><p id="dli_02_0230__p11818592111">Create a Flink Jar job named <strong id="dli_02_0230__b1550063773810">test</strong>, set the job to be executed on <strong id="dli_02_0230__b17758615134517">testQueue</strong>, set the number of CUs used by the job, and enable the job log function.</p>
<pre class="screen" id="dli_02_0230__screen1411318194306">{
"name": "test",
"desc": "job for test",
"queue_name": "testQueue",
"manager_cu_number": 1,
"cu_number": 2,
"parallel_number": 1,
"tm_cus": 1,
"tm_slot_num": 1,
"log_enabled": true,
"obs_bucket": "bucketName",
"smn_topic": "topic",
"main_class": "org.apache.flink.examples.streaming.JavaQueueStream",
"restart_when_exception": false,
"entrypoint": "javaQueueStream.jar",
"entrypoint_args":"-windowSize 2000 -rate 3",
"dependency_jars": [
"myGroup/test.jar",
"myGroup/test1.jar"
],
"dependency_files": [
"myGroup/test.csv",
"myGroup/test1.csv"
]
}</pre>
</div>
<div class="section" id="dli_02_0230__section1572521517329"><h4 class="sectiontitle">Example Response</h4><pre class="screen" id="dli_02_0230__s6d0d234a671f4e618d1a2b5e746cff26">{
"is_success": true,
"message": "A Flink job is created successfully.",
"job": {
"job_id": 138,
"status_name": "job_init",
"status_desc": ""
}
}</pre>
</div>
<div class="section" id="dli_02_0230__s1b495ba11cd9411c9ad2ee50103334a7"><h4 class="sectiontitle">Status Codes</h4><p id="dli_02_0230__acef1445366354016b2ed90921927a555"><a href="#dli_02_0230__t43c1f1c0ba344f4cbcb270953d9cca2a">Table 6</a> describes status codes.</p>
<div class="tablenoborder"><a name="dli_02_0230__t43c1f1c0ba344f4cbcb270953d9cca2a"></a><a name="t43c1f1c0ba344f4cbcb270953d9cca2a"></a><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0230__t43c1f1c0ba344f4cbcb270953d9cca2a" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Status codes</caption><thead align="left"><tr id="dli_02_0230__r2ad0f008ce2248a1800a3e8b77226a56"><th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.7.3.2.3.1.1"><p id="dli_02_0230__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_0230__af801170b350b4f8ba3b575c7ddb8b13e">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dli_02_0230__r0b449b1d3b8c498ea3e6cce16c80a14c"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.7.3.2.3.1.1 "><p id="dli_02_0230__a8c63a97e3bad402ebaead0bd99cad632">200</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.7.3.2.3.1.2 "><p id="dli_02_0230__af86844c7bb364c48b6300df1af164af2">The custom Flink job is created successfully.</p>
</td>
</tr>
<tr id="dli_02_0230__row1012873412149"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.7.3.2.3.1.1 "><p id="dli_02_0230__p1912813348145">400</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.7.3.2.3.1.2 "><p id="dli_02_0230__p154287617445">The input parameter is invalid.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="dli_02_0230__section13596141025715"><h4 class="sectiontitle">Error Codes</h4><p id="dli_02_0230__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