doc-exports/docs/dli/api-ref/dli_02_0316.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

261 lines
19 KiB
HTML

<a name="dli_02_0316"></a><a name="dli_02_0316"></a>
<h1 class="topictitle1">Generating a Static Stream Graph for a Flink SQL Job</h1>
<div id="body0000001073888705"><div class="section" id="dli_02_0316__s89ff8bc59cba4c3b94dc17e85c8fa1ea"><h4 class="sectiontitle">Function</h4><p id="dli_02_0316__a4deaa8ebc392424e869c47835399ab23">This API is used to generate a static stream graph for a Flink SQL job.</p>
</div>
<div class="section" id="dli_02_0316__sef21e3efc2a44a84a03adad33a1ae006"><h4 class="sectiontitle">URI</h4><ul id="dli_02_0316__uf99c5b2f64a44669a611cae56296b336"><li id="dli_02_0316__l02802a572cd14322a9edb44c392d1063">URI format<p id="dli_02_0316__p1928010377105"><a name="dli_02_0316__l02802a572cd14322a9edb44c392d1063"></a><a name="l02802a572cd14322a9edb44c392d1063"></a>POST /v3/{<em id="dli_02_0316__i72872097262">project_id</em>}/streaming/jobs/{<em id="dli_02_0316__i18230191215262">job_id</em>}/gen-graph</p>
</li><li id="dli_02_0316__lab001edff5ca4cde843db03812f0979d">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0316__t219b031199884ac1bb9e91158ddc9efb" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameter</caption><thead align="left"><tr id="dli_02_0316__r04005eeda24e4db9b06516450d4d56af"><th align="left" class="cellrowborder" valign="top" width="11.63%" id="mcps1.3.2.2.2.1.2.5.1.1"><p id="dli_02_0316__a80847df5e5dc448caa46a2ff258fa2c4">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="10.979999999999999%" id="mcps1.3.2.2.2.1.2.5.1.2"><p id="dli_02_0316__af54fc16087b049c98f748c1a2faace17">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="11.76%" id="mcps1.3.2.2.2.1.2.5.1.3"><p id="dli_02_0316__p201051414144319">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="65.63%" id="mcps1.3.2.2.2.1.2.5.1.4"><p id="dli_02_0316__a484a3e0ce14846799c727ccbd4075d6c">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dli_02_0316__r8022e11be3f54ad290cf8c848a56a550"><td class="cellrowborder" valign="top" width="11.63%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="dli_02_0316__p1262440203315">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="10.979999999999999%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="dli_02_0316__p1016041415356">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="11.76%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="dli_02_0316__p1710515149436">String</p>
</td>
<td class="cellrowborder" valign="top" width="65.63%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="dli_02_0316__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_0316__s3afece1037ea4f62aeffb3db49b97f70"><h4 class="sectiontitle">Request</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0316__table11209133616498" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request parameters</caption><thead align="left"><tr id="dli_02_0316__row1621093613496"><th align="left" class="cellrowborder" valign="top" width="23.49%" id="mcps1.3.3.2.2.5.1.1"><p id="dli_02_0316__p82102036194919">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="12.36%" id="mcps1.3.3.2.2.5.1.2"><p id="dli_02_0316__p17210143634912">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.44%" id="mcps1.3.3.2.2.5.1.3"><p id="dli_02_0316__p15210436174916">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="49.71%" id="mcps1.3.3.2.2.5.1.4"><p id="dli_02_0316__p62101436144911">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dli_02_0316__row9210193614919"><td class="cellrowborder" valign="top" width="23.49%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0316__p1813915305540">sql_body</p>
</td>
<td class="cellrowborder" valign="top" width="12.36%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0316__p12107369490">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.44%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0316__p14210736184920">String</p>
</td>
<td class="cellrowborder" valign="top" width="49.71%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0316__p8501636105418">SQL</p>
</td>
</tr>
<tr id="dli_02_0316__row68519283358"><td class="cellrowborder" valign="top" width="23.49%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0316__p398143055414">cu_number</p>
</td>
<td class="cellrowborder" valign="top" width="12.36%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0316__p128531028143515">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.44%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0316__p20853112863510">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="49.71%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0316__p097113575418">Total number of CUs.</p>
</td>
</tr>
<tr id="dli_02_0316__row129641482552"><td class="cellrowborder" valign="top" width="23.49%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0316__p209655488551">manager_cu_number</p>
</td>
<td class="cellrowborder" valign="top" width="12.36%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0316__p1596544825513">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.44%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0316__p1596554816550">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="49.71%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0316__p4965348135511">Number of CUs of the management unit.</p>
</td>
</tr>
<tr id="dli_02_0316__row7965204825518"><td class="cellrowborder" valign="top" width="23.49%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0316__p254015503566">parallel_number</p>
</td>
<td class="cellrowborder" valign="top" width="12.36%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0316__p165419508567">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.44%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0316__p89659481550">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="49.71%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0316__p3965164812554">Maximum degree of parallelism.</p>
</td>
</tr>
<tr id="dli_02_0316__row13632219574"><td class="cellrowborder" valign="top" width="23.49%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0316__p1928953514572">tm_cus</p>
</td>
<td class="cellrowborder" valign="top" width="12.36%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0316__p252615525910">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.44%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0316__p1941320175812">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="49.71%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0316__p10289123535718">Number of CUs in a taskManager.</p>
</td>
</tr>
<tr id="dli_02_0316__row177162213575"><td class="cellrowborder" valign="top" width="23.49%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0316__p1929033505710">tm_slot_num</p>
</td>
<td class="cellrowborder" valign="top" width="12.36%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0316__p1526254593">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.44%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0316__p141120115819">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="49.71%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0316__p1344620185590">Number of slots in a taskManager.</p>
</td>
</tr>
<tr id="dli_02_0316__row7852217574"><td class="cellrowborder" valign="top" width="23.49%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0316__p1429013565718">operator_config</p>
</td>
<td class="cellrowborder" valign="top" width="12.36%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0316__p652610517591">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.44%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0316__p1290235175713">String</p>
</td>
<td class="cellrowborder" valign="top" width="49.71%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0316__p165355296594">Operator configurations.</p>
</td>
</tr>
<tr id="dli_02_0316__row88172216571"><td class="cellrowborder" valign="top" width="23.49%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0316__p1529017351575">static_estimator</p>
</td>
<td class="cellrowborder" valign="top" width="12.36%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0316__p6287188590">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.44%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0316__p22901359579">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="49.71%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0316__p1947193825916">Whether to estimate static resources.</p>
</td>
</tr>
<tr id="dli_02_0316__row136102051185718"><td class="cellrowborder" valign="top" width="23.49%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0316__p5819026586">job_type</p>
</td>
<td class="cellrowborder" valign="top" width="12.36%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0316__p5287483591">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.44%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0316__p1081918219588">String</p>
</td>
<td class="cellrowborder" valign="top" width="49.71%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0316__p51721821131616">Job types.</p>
<p id="dli_02_0316__p138195218580">Only <strong id="dli_02_0316__b1513616271289">flink_opensource_sql_job job</strong> is supported.</p>
</td>
</tr>
<tr id="dli_02_0316__row9610451125713"><td class="cellrowborder" valign="top" width="23.49%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0316__p148192025580">graph_type</p>
</td>
<td class="cellrowborder" valign="top" width="12.36%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0316__p1287158125917">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.44%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0316__p181982185811">String</p>
</td>
<td class="cellrowborder" valign="top" width="49.71%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0316__p134625013501">Stream graph type. Currently, the following two types of stream graphs are supported:</p>
<ul id="dli_02_0316__ul14347142155017"><li id="dli_02_0316__li46304435019"><strong id="dli_02_0316__b1215751203611">simple_graph</strong>: Simplified stream graph</li><li id="dli_02_0316__li11347126506"><strong id="dli_02_0316__b24251419103615">job_graph</strong>: Static stream graph</li></ul>
</td>
</tr>
<tr id="dli_02_0316__row64561624115312"><td class="cellrowborder" valign="top" width="23.49%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0316__p432792704815">static_estimator_config</p>
</td>
<td class="cellrowborder" valign="top" width="12.36%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0316__p1432702717489">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.44%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0316__p12327182716481">String</p>
</td>
<td class="cellrowborder" valign="top" width="49.71%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0316__p1732815276486">Traffic or hit ratio of each operator, which is a string in JSON format.</p>
</td>
</tr>
<tr id="dli_02_0316__row160621171715"><td class="cellrowborder" valign="top" width="23.49%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0316__p151566375316">flink_version</p>
</td>
<td class="cellrowborder" valign="top" width="12.36%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0316__p11156633539">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.44%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0316__p171568315310">String</p>
</td>
<td class="cellrowborder" valign="top" width="49.71%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0316__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_0316__se2bf80cdb76541308f69f258ea4b1bd6"><h4 class="sectiontitle">Response</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0316__t5995d65f65ba4ebca8606202112b407e" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response parameters</caption><thead align="left"><tr id="dli_02_0316__ra7acea51e4b4437e917d21fe99f130a3"><th align="left" class="cellrowborder" valign="top" width="14.84%" id="mcps1.3.4.2.2.5.1.1"><p id="dli_02_0316__a5af940f2267747ef871c67c86a0be82e">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="12.47%" id="mcps1.3.4.2.2.5.1.2"><p id="dli_02_0316__abcfbd3a651704d539626f3a41cc744f5">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.23%" id="mcps1.3.4.2.2.5.1.3"><p id="dli_02_0316__a2351d8d266444ad3ad1c09540d6d81cc">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="55.46%" id="mcps1.3.4.2.2.5.1.4"><p id="dli_02_0316__af7ea6a3f59844bdf99d51e90d570be4c">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dli_02_0316__rca1bdb55f4dc497ca8fee7537232f274"><td class="cellrowborder" valign="top" width="14.84%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0316__p1045315113248">is_success</p>
</td>
<td class="cellrowborder" valign="top" width="12.47%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0316__p15453131112419">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17.23%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0316__p6453411132414">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="55.46%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0316__p05081222182420">Indicates whether the request is successfully executed. Value <strong id="dli_02_0316__b44483682918">true</strong> indicates that the request is successfully executed.</p>
</td>
</tr>
<tr id="dli_02_0316__r3900d023a26e45dea9a0ad9dd60d8ab1"><td class="cellrowborder" valign="top" width="14.84%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0316__p645351113242">message</p>
</td>
<td class="cellrowborder" valign="top" width="12.47%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0316__p1445410112249">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17.23%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0316__p1845441117241">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.46%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0316__p1573323415243">System prompt. If execution succeeds, the message may be left blank.</p>
</td>
</tr>
<tr id="dli_02_0316__row26371718116"><td class="cellrowborder" valign="top" width="14.84%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0316__p26167121818">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="12.47%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0316__p261671219110">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17.23%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0316__p196164123114">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.46%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0316__p106381211319">Error codes.</p>
</td>
</tr>
<tr id="dli_02_0316__row21031568411"><td class="cellrowborder" valign="top" width="14.84%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0316__p64152422112">stream_graph</p>
</td>
<td class="cellrowborder" valign="top" width="12.47%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0316__p1520313541617">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17.23%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0316__p9415542818">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.46%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0316__p1741684216113">Description of a static stream graph.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="dli_02_0316__section1130754105710"><h4 class="sectiontitle">Example Request</h4><p id="dli_02_0316__p5531158141513">Generate a static stream graph for a Flink SQL job.</p>
<pre class="screen" id="dli_02_0316__screen15209183612499">{
"cu_number": 4,
"manager_cu_number": 1,
"parallel_number": 4,
"tm_cus": 1,
"tm_slot_num": 1,
"sql_body": "",
"operator_config": "",
"static_estimator": true,
"job_type": "flink_opensource_sql_job",
"graph_type": "job_graph"
}</pre>
</div>
<div class="section" id="dli_02_0316__section339884412434"><h4 class="sectiontitle">Example Response</h4><pre class="screen" id="dli_02_0316__s6d0d234a671f4e618d1a2b5e746cff26">{
"is_success": true,
"message": "",
"error_code": "",
"stream_graph": "{\n \"nodes\" : [ {\n \"id\" : 1,\n \"operator_id\" : \"bc764cd8ddf7a0cff126f51c16239658\",\n \"type\" : \"Source\",\n
\"contents\" : \"kafkaSource\",\n \"parallelism\" : 1\n }, {\n \"id\" : 2,\n \"operator_id\" : \"0a448493b4782967b150582570326227\",\n \"type\" : \"select\",\n \"contents\" : \"car_id, car_owner, car_brand, car_speed\",\n \"parallelism\" : 1,\n \"predecessors\" : [ {\n \"id\" : 1\n } ]\n }, {\n \"id\" : 4,\n \"operator_id\" : \"6d2677a0ecc3fd8df0b72ec675edf8f4\",\n \"type\" : \"Sink\",\n \"contents\" : \"kafkaSink\",\n \"parallelism\" : 1,\n \"predecessors\" : [ {\n \"id\" : 2\n } ]\n } ]\n}"
}</pre>
</div>
<div class="section" id="dli_02_0316__s1b495ba11cd9411c9ad2ee50103334a7"><h4 class="sectiontitle">Status Codes</h4><p id="dli_02_0316__acef1445366354016b2ed90921927a555"><a href="#dli_02_0316__t43c1f1c0ba344f4cbcb270953d9cca2a">Table 4</a> describes status codes.</p>
<div class="tablenoborder"><a name="dli_02_0316__t43c1f1c0ba344f4cbcb270953d9cca2a"></a><a name="t43c1f1c0ba344f4cbcb270953d9cca2a"></a><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0316__t43c1f1c0ba344f4cbcb270953d9cca2a" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Status codes</caption><thead align="left"><tr id="dli_02_0316__r2ad0f008ce2248a1800a3e8b77226a56"><th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.7.3.2.3.1.1"><p id="dli_02_0316__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_0316__af801170b350b4f8ba3b575c7ddb8b13e">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dli_02_0316__r0b449b1d3b8c498ea3e6cce16c80a14c"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.7.3.2.3.1.1 "><p id="dli_02_0316__a8c63a97e3bad402ebaead0bd99cad632">200</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.7.3.2.3.1.2 "><p id="dli_02_0316__af86844c7bb364c48b6300df1af164af2">The operation is successful.</p>
</td>
</tr>
<tr id="dli_02_0316__row1232118139110"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.7.3.2.3.1.1 "><p id="dli_02_0316__p14321113711">400</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.7.3.2.3.1.2 "><p id="dli_02_0316__p1832191314113">The input parameter is invalid.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="dli_02_0316__section13596141025715"><h4 class="sectiontitle">Error Codes</h4><p id="dli_02_0316__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>