forked from docs/doc-exports
Su, Xiaomeng
483e5cc6cc
Reviewed-by: Pruthi, Vineet <vineet.pruthi@t-systems.com> Co-authored-by: Su, Xiaomeng <suxiaomeng1@huawei.com> Co-committed-by: Su, Xiaomeng <suxiaomeng1@huawei.com>
208 lines
14 KiB
HTML
208 lines
14 KiB
HTML
<a name="dli_02_0236"></a><a name="dli_02_0236"></a>
|
|
|
|
<h1 class="topictitle1">Querying the Job Execution Plan</h1>
|
|
<div id="body1574749525718"><div class="section" id="dli_02_0236__section1150605415481"><h4 class="sectiontitle">Function</h4><p id="dli_02_0236__p25947479488">This API is used to query a job execution plan.</p>
|
|
</div>
|
|
<div class="section" id="dli_02_0236__section194991194914"><h4 class="sectiontitle">URI</h4><ul id="dli_02_0236__ul1859464734815"><li id="dli_02_0236__li459434719487">URI format<p id="dli_02_0236__p15594347124811"><a name="dli_02_0236__li459434719487"></a><a name="li459434719487"></a>GET /v1.0/{project_id}/streaming/jobs/{job_id}/execute-graph</p>
|
|
</li><li id="dli_02_0236__li7594147194819">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0236__table722313116497" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameters</caption><thead align="left"><tr id="dli_02_0236__row22245312496"><th align="left" class="cellrowborder" valign="top" width="12.73%" id="mcps1.3.2.2.2.1.2.5.1.1"><p id="dli_02_0236__p128632617494">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="11.01%" id="mcps1.3.2.2.2.1.2.5.1.2"><p id="dli_02_0236__p38612654917">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="12.18%" id="mcps1.3.2.2.2.1.2.5.1.3"><p id="dli_02_0236__p86353401487">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="64.08%" id="mcps1.3.2.2.2.1.2.5.1.4"><p id="dli_02_0236__p38614260496">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dli_02_0236__row12224173194918"><td class="cellrowborder" valign="top" width="12.73%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="dli_02_0236__p08610263490">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.01%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="dli_02_0236__p1086162619493">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.18%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="dli_02_0236__p6635124011814">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="64.08%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="dli_02_0236__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_0236__row1299005282510"><td class="cellrowborder" valign="top" width="12.73%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="dli_02_0236__p49908527251">job_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.01%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="dli_02_0236__p13990125292512">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.18%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="dli_02_0236__p1263514401884">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="64.08%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="dli_02_0236__p39906526253">Job ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="dli_02_0236__section142592165017"><h4 class="sectiontitle">Request</h4><p id="dli_02_0236__p1859504719486">None</p>
|
|
</div>
|
|
<div class="section" id="dli_02_0236__section883499205015"><h4 class="sectiontitle">Response</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0236__table1855931205014" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response parameters</caption><thead align="left"><tr id="dli_02_0236__row585520319505"><th align="left" class="cellrowborder" valign="top" width="19.54%" id="mcps1.3.4.2.2.5.1.1"><p id="dli_02_0236__p929594865016">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16.13%" id="mcps1.3.4.2.2.5.1.2"><p id="dli_02_0236__p2295184814502">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="27.150000000000002%" id="mcps1.3.4.2.2.5.1.3"><p id="dli_02_0236__p129514817501">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="37.18%" id="mcps1.3.4.2.2.5.1.4"><p id="dli_02_0236__p9295948105019">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dli_02_0236__row88561931195016"><td class="cellrowborder" valign="top" width="19.54%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0236__p8377184019">is_success</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.13%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0236__p14722114010">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="27.150000000000002%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0236__p1334713403">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="37.18%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0236__p18314704017">Whether the request is successful.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0236__row158562310504"><td class="cellrowborder" valign="top" width="19.54%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0236__p3615715408">message</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.13%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0236__p146157184011">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="27.150000000000002%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0236__p196771402">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="37.18%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0236__p36107164015">Message content.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0236__row12995192310419"><td class="cellrowborder" valign="top" width="19.54%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0236__p1916172604117">execute_graph</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.13%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0236__p1416118268414">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="27.150000000000002%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0236__p1716182624118">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="37.18%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0236__p716112260414">Response parameter for querying a job plan. For details, see <a href="#dli_02_0236__table11948152164215">Table 3</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="dli_02_0236__table11948152164215"></a><a name="table11948152164215"></a><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0236__table11948152164215" frame="border" border="1" rules="all"><caption><b>Table 3 </b><strong id="dli_02_0236__b49272532138">execute_graph</strong> parameters</caption><thead align="left"><tr id="dli_02_0236__row16882053154215"><th align="left" class="cellrowborder" valign="top" width="17.141714171417142%" id="mcps1.3.4.3.2.5.1.1"><p id="dli_02_0236__p5881538428"><strong id="dli_02_0236__b59067565446">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="14.361436143614362%" id="mcps1.3.4.3.2.5.1.2"><p id="dli_02_0236__p178814530426">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16.611661166116612%" id="mcps1.3.4.3.2.5.1.3"><p id="dli_02_0236__p10411153613482">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="51.88518851885189%" id="mcps1.3.4.3.2.5.1.4"><p id="dli_02_0236__p17889538428">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dli_02_0236__row988105320424"><td class="cellrowborder" valign="top" width="17.141714171417142%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dli_02_0236__p1020153124710">jid</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.361436143614362%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0236__p14203312479">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.611661166116612%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0236__p1411183684810">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.88518851885189%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0236__p19794118165011">ID of a Flink job.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0236__row988953184219"><td class="cellrowborder" valign="top" width="17.141714171417142%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dli_02_0236__p820143194711">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.361436143614362%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0236__p72063174711">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.611661166116612%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0236__p3412143684812">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.88518851885189%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0236__p1242124015500">Name of a Flink job.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0236__row2891553174211"><td class="cellrowborder" valign="top" width="17.141714171417142%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dli_02_0236__p52014317474">isStoppable</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.361436143614362%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0236__p18202319476">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.611661166116612%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0236__p144121436124812">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.88518851885189%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0236__p1724615111505">Whether a job can be stopped.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0236__row589185314422"><td class="cellrowborder" valign="top" width="17.141714171417142%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dli_02_0236__p82063154711">state</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.361436143614362%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0236__p8211832471">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.611661166116612%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0236__p16412103619484">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.88518851885189%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0236__p7504185814503">Execution status of a job.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0236__row5891453184216"><td class="cellrowborder" valign="top" width="17.141714171417142%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dli_02_0236__p15219354713">start-time</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.361436143614362%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0236__p821133134718">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.611661166116612%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0236__p7412163613484">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.88518851885189%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0236__p166073616517">Time when a job is started.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0236__row5902053104213"><td class="cellrowborder" valign="top" width="17.141714171417142%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dli_02_0236__p9214318477">end-time</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.361436143614362%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0236__p182103194712">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.611661166116612%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0236__p1941213613487">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.88518851885189%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0236__p16473191418515">Time when a job is stopped.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0236__row490195317423"><td class="cellrowborder" valign="top" width="17.141714171417142%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dli_02_0236__p322633477">duration</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.361436143614362%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0236__p1422734473">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.611661166116612%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0236__p13412136164813">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.88518851885189%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0236__p183458266514">Running duration of a job.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="dli_02_0236__section1130754105710"><h4 class="sectiontitle">Example Request</h4><p id="dli_02_0236__p167081433933">None</p>
|
|
</div>
|
|
<div class="section" id="dli_02_0236__section10939134817219"><h4 class="sectiontitle">Example Response</h4><pre class="screen" id="dli_02_0236__screen45521012165214">{
|
|
"is_success": "true",
|
|
"message": "Querying the job execution graph succeeds.",
|
|
"execute_graph": {
|
|
"jid": "4e966f43f2c90b0e1bf3188ecf55504b",
|
|
"name": "",
|
|
"isStoppable": false,
|
|
"state": "RUNNING",
|
|
"start-time": 1578904488436,
|
|
"end-time": -1,
|
|
"duration": 516274
|
|
}
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="dli_02_0236__section2013612106511"><h4 class="sectiontitle">Status Codes</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0236__table181259166119" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Status codes</caption><thead align="left"><tr id="dli_02_0236__row21258169115"><th align="left" class="cellrowborder" valign="top" width="19.29%" id="mcps1.3.7.2.2.3.1.1"><p id="dli_02_0236__p13125716519">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="80.71000000000001%" id="mcps1.3.7.2.2.3.1.2"><p id="dli_02_0236__p612514169110">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dli_02_0236__row412517161919"><td class="cellrowborder" valign="top" width="19.29%" headers="mcps1.3.7.2.2.3.1.1 "><p id="dli_02_0236__p16597947144818">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="80.71000000000001%" headers="mcps1.3.7.2.2.3.1.2 "><p id="dli_02_0236__p15971847184818">Querying the job execution plan succeeds.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0236__row9126716712"><td class="cellrowborder" valign="top" width="19.29%" headers="mcps1.3.7.2.2.3.1.1 "><p id="dli_02_0236__p8597347174817">400</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="80.71000000000001%" headers="mcps1.3.7.2.2.3.1.2 "><p id="dli_02_0236__p359774719486">The input parameter is invalid.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="dli_02_0236__section13596141025715"><h4 class="sectiontitle">Error Codes</h4><p id="dli_02_0236__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>
|
|
|