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>
162 lines
13 KiB
HTML
162 lines
13 KiB
HTML
<a name="dli_02_0254"></a><a name="dli_02_0254"></a>
|
|
|
|
<h1 class="topictitle1">Exporting a Flink Job</h1>
|
|
<div id="body1586937546505"><div class="section" id="dli_02_0254__s89ff8bc59cba4c3b94dc17e85c8fa1ea"><h4 class="sectiontitle">Function</h4><p id="dli_02_0254__a4deaa8ebc392424e869c47835399ab23">This API is used to export Flink job data.</p>
|
|
</div>
|
|
<div class="section" id="dli_02_0254__sef21e3efc2a44a84a03adad33a1ae006"><h4 class="sectiontitle">URI</h4><ul id="dli_02_0254__uf99c5b2f64a44669a611cae56296b336"><li id="dli_02_0254__l02802a572cd14322a9edb44c392d1063">URI format<p id="dli_02_0254__p1928010377105"><a name="dli_02_0254__l02802a572cd14322a9edb44c392d1063"></a><a name="l02802a572cd14322a9edb44c392d1063"></a>POST /v1.0/{project_id}/streaming/jobs/export</p>
|
|
</li><li id="dli_02_0254__lab001edff5ca4cde843db03812f0979d">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0254__t219b031199884ac1bb9e91158ddc9efb" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameter</caption><thead align="left"><tr id="dli_02_0254__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_0254__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_0254__af54fc16087b049c98f748c1a2faace17">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="13.209999999999999%" id="mcps1.3.2.2.2.1.2.5.1.3"><p id="dli_02_0254__p101011930184013">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="64.18%" id="mcps1.3.2.2.2.1.2.5.1.4"><p id="dli_02_0254__a484a3e0ce14846799c727ccbd4075d6c">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dli_02_0254__r8022e11be3f54ad290cf8c848a56a550"><td class="cellrowborder" valign="top" width="11.63%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="dli_02_0254__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_0254__p1016041415356">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.209999999999999%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="dli_02_0254__p10101130174017">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="64.18%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="dli_02_0254__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_0254__s3afece1037ea4f62aeffb3db49b97f70"><h4 class="sectiontitle">Request</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0254__table11209133616498" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request parameters</caption><thead align="left"><tr id="dli_02_0254__row1621093613496"><th align="left" class="cellrowborder" valign="top" width="16.831683168316832%" id="mcps1.3.3.2.2.5.1.1"><p id="dli_02_0254__p82102036194919">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17.82178217821782%" id="mcps1.3.3.2.2.5.1.2"><p id="dli_02_0254__p17210143634912">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="12.871287128712872%" id="mcps1.3.3.2.2.5.1.3"><p id="dli_02_0254__p15210436174916">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="52.475247524752476%" id="mcps1.3.3.2.2.5.1.4"><p id="dli_02_0254__p62101436144911">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dli_02_0254__row9210193614919"><td class="cellrowborder" valign="top" width="16.831683168316832%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0254__p122101936164915">obs_dir</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.82178217821782%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0254__p12107369490">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.871287128712872%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0254__p14210736184920">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.475247524752476%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0254__p14949172263716">OBS path for storing exported job files.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0254__row68519283358"><td class="cellrowborder" valign="top" width="16.831683168316832%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0254__p58539281359">is_selected</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.82178217821782%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0254__p128531028143515">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.871287128712872%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0254__p20853112863510">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.475247524752476%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0254__p4149102623818">Whether to export a specified job.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0254__row038520335354"><td class="cellrowborder" valign="top" width="16.831683168316832%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0254__p173851233103518">job_selected</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.82178217821782%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0254__p1638583313358">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.871287128712872%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0254__p438663353517">Array of Longs</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.475247524752476%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0254__p1976111153391">This parameter indicates the ID set of jobs to be exported if <span class="parmname" id="dli_02_0254__parmname14960133320395"><b>is_selected</b></span> is set to <span class="parmvalue" id="dli_02_0254__parmvalue1270884343920"><b>true</b></span>.</p>
|
|
<div class="note" id="dli_02_0254__note7829151619401"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="dli_02_0254__p78401116184010">This parameter is mandatory when <span class="parmname" id="dli_02_0254__parmname168173232401"><b>is_selected</b></span> is set to <span class="parmvalue" id="dli_02_0254__parmvalue98181223134016"><b>true</b></span>.</p>
|
|
</div></div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="dli_02_0254__se2bf80cdb76541308f69f258ea4b1bd6"><h4 class="sectiontitle">Response</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0254__t5995d65f65ba4ebca8606202112b407e" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response parameters</caption><thead align="left"><tr id="dli_02_0254__ra7acea51e4b4437e917d21fe99f130a3"><th align="left" class="cellrowborder" valign="top" width="14.85148514851485%" id="mcps1.3.4.2.2.5.1.1"><p id="dli_02_0254__a5af940f2267747ef871c67c86a0be82e">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18.81188118811881%" id="mcps1.3.4.2.2.5.1.2"><p id="dli_02_0254__abcfbd3a651704d539626f3a41cc744f5">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="13.861386138613863%" id="mcps1.3.4.2.2.5.1.3"><p id="dli_02_0254__a2351d8d266444ad3ad1c09540d6d81cc">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="52.475247524752476%" id="mcps1.3.4.2.2.5.1.4"><p id="dli_02_0254__af7ea6a3f59844bdf99d51e90d570be4c">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dli_02_0254__rca1bdb55f4dc497ca8fee7537232f274"><td class="cellrowborder" valign="top" width="14.85148514851485%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0254__p1045315113248">is_success</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.81188118811881%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0254__p15453131112419">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.861386138613863%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0254__p6453411132414">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.475247524752476%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0254__p05081222182420">Indicates whether the request is successfully executed. Value <strong id="dli_02_0254__b17138911431">true</strong> indicates that the request is successfully executed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0254__r3900d023a26e45dea9a0ad9dd60d8ab1"><td class="cellrowborder" valign="top" width="14.85148514851485%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0254__p645351113242">message</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.81188118811881%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0254__p1445410112249">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.861386138613863%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0254__p1845441117241">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.475247524752476%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0254__p1573323415243">System prompt. If execution succeeds, the parameter setting may be left blank.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0254__row21031568411"><td class="cellrowborder" valign="top" width="14.85148514851485%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0254__p81041556174120">zip_file</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.81188118811881%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0254__p2010413566417">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.861386138613863%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0254__p1410420561419">Array of Strings</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.475247524752476%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0254__p10807332204210">Name of the ZIP package containing exported jobs. The ZIP package is stored on OBS.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="dli_02_0254__section1130754105710"><h4 class="sectiontitle">Example Request</h4><p id="dli_02_0254__p135895301130">Export the job whose ID is <strong id="dli_02_0254__b171148281536">100</strong> to OBS.</p>
|
|
<pre class="screen" id="dli_02_0254__screen15209183612499">{
|
|
"obs_dir": "obs-test",
|
|
"is_selected": true,
|
|
"job_selected": [100]
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="dli_02_0254__section103595364118"><h4 class="sectiontitle">Example Response</h4><pre class="screen" id="dli_02_0254__s6d0d234a671f4e618d1a2b5e746cff26">{
|
|
"is_success": true,
|
|
"message": "The job is exported successfully.",
|
|
"zip_file": ["obs-test/aggregate_1582677879475.zip"]
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="dli_02_0254__s1b495ba11cd9411c9ad2ee50103334a7"><h4 class="sectiontitle">Status Codes</h4><p id="dli_02_0254__acef1445366354016b2ed90921927a555"><a href="#dli_02_0254__t43c1f1c0ba344f4cbcb270953d9cca2a">Table 4</a> describes status codes.</p>
|
|
|
|
<div class="tablenoborder"><a name="dli_02_0254__t43c1f1c0ba344f4cbcb270953d9cca2a"></a><a name="t43c1f1c0ba344f4cbcb270953d9cca2a"></a><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0254__t43c1f1c0ba344f4cbcb270953d9cca2a" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Status codes</caption><thead align="left"><tr id="dli_02_0254__r2ad0f008ce2248a1800a3e8b77226a56"><th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.7.3.2.3.1.1"><p id="dli_02_0254__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_0254__af801170b350b4f8ba3b575c7ddb8b13e">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dli_02_0254__r0b449b1d3b8c498ea3e6cce16c80a14c"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.7.3.2.3.1.1 "><p id="dli_02_0254__a8c63a97e3bad402ebaead0bd99cad632">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.7.3.2.3.1.2 "><p id="dli_02_0254__af86844c7bb364c48b6300df1af164af2">The job is exported successfully.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0254__row1232118139110"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.7.3.2.3.1.1 "><p id="dli_02_0254__p14321113711">400</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.7.3.2.3.1.2 "><p id="dli_02_0254__p1832191314113">The input parameter is invalid.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="dli_02_0254__section13596141025715"><h4 class="sectiontitle">Error Codes</h4><p id="dli_02_0254__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>
|
|
|