forked from docs/doc-exports
Xiong, Chen Xiao
f2733178cc
Reviewed-by: Kacur, Michal <michal.kacur@t-systems.com> Co-authored-by: Xiong, Chen Xiao <chenxiaoxiong@huawei.com> Co-committed-by: Xiong, Chen Xiao <chenxiaoxiong@huawei.com>
124 lines
12 KiB
HTML
124 lines
12 KiB
HTML
<a name="dataartsstudio_02_0089"></a><a name="dataartsstudio_02_0089"></a>
|
|
|
|
<h1 class="topictitle1">Batch Exporting Jobs</h1>
|
|
<div id="body0000001104334922"><div class="section" id="dataartsstudio_02_0089__en-us_topic_0181281361_section1738101810182"><h4 class="sectiontitle">Function</h4><p id="dataartsstudio_02_0089__en-us_topic_0181281361_p1912913467404">This API is used to batch export jobs, including job dependency scripts and CDM job definitions.</p>
|
|
</div>
|
|
<div class="section" id="dataartsstudio_02_0089__en-us_topic_0181281361_section7934966101819"><h4 class="sectiontitle">URI</h4><ul id="dataartsstudio_02_0089__en-us_topic_0181281361_ul145591424184717"><li id="dataartsstudio_02_0089__en-us_topic_0181281361_li356152404715">URI format<p id="dataartsstudio_02_0089__en-us_topic_0181281361_p076674419427"><a name="dataartsstudio_02_0089__en-us_topic_0181281361_li356152404715"></a><a name="en-us_topic_0181281361_li356152404715"></a>POST /v1/{project_id}/jobs/batch-export</p>
|
|
</li></ul>
|
|
<ul id="dataartsstudio_02_0089__en-us_topic_0181281361_ul1370917277482"><li id="dataartsstudio_02_0089__en-us_topic_0181281361_li170972720484">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dataartsstudio_02_0089__en-us_topic_0181281361_en-us_topic_0093082049_table46023801181358" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameter</caption><thead align="left"><tr id="dataartsstudio_02_0089__en-us_topic_0181281361_en-us_topic_0093082049_row26974916181358"><th align="left" class="cellrowborder" valign="top" width="20.18%" id="mcps1.3.2.3.1.1.2.5.1.1"><p id="dataartsstudio_02_0089__en-us_topic_0181281361_en-us_topic_0093082049_p37484572181358">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="10.530000000000001%" id="mcps1.3.2.3.1.1.2.5.1.2"><p id="dataartsstudio_02_0089__en-us_topic_0181281361_en-us_topic_0093082049_p16351468181358">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16.24%" id="mcps1.3.2.3.1.1.2.5.1.3"><p id="dataartsstudio_02_0089__en-us_topic_0181281361_en-us_topic_0093082049_p49400541181358">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="53.05%" id="mcps1.3.2.3.1.1.2.5.1.4"><p id="dataartsstudio_02_0089__en-us_topic_0181281361_en-us_topic_0093082049_p42020886181358">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dataartsstudio_02_0089__en-us_topic_0181281361_en-us_topic_0093082049_row48248640181358"><td class="cellrowborder" valign="top" width="20.18%" headers="mcps1.3.2.3.1.1.2.5.1.1 "><p id="dataartsstudio_02_0089__en-us_topic_0181281361_en-us_topic_0093082049_p15825795181358">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.530000000000001%" headers="mcps1.3.2.3.1.1.2.5.1.2 "><p id="dataartsstudio_02_0089__en-us_topic_0181281361_en-us_topic_0093082049_p6820998181358">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.24%" headers="mcps1.3.2.3.1.1.2.5.1.3 "><p id="dataartsstudio_02_0089__en-us_topic_0181281361_en-us_topic_0093082049_p15629937181358">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.05%" headers="mcps1.3.2.3.1.1.2.5.1.4 "><p id="dataartsstudio_02_0089__en-us_topic_0181281361_p8672138175612">Project ID. For details about how to obtain a project ID, see <a href="dataartsstudio_02_0314.html">Project ID and Account ID</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="dataartsstudio_02_0089__en-us_topic_0181281361_section10789431145710"><h4 class="sectiontitle">Request</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dataartsstudio_02_0089__en-us_topic_0181281361_table25071810112414" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameter</caption><thead align="left"><tr id="dataartsstudio_02_0089__en-us_topic_0181281361_en-us_topic_0181281363_row3746915131710"><th align="left" class="cellrowborder" valign="top" width="15.010000000000002%" id="mcps1.3.3.2.2.5.1.1"><p id="dataartsstudio_02_0089__en-us_topic_0181281361_en-us_topic_0181281363_p131491731112013">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16.93%" id="mcps1.3.3.2.2.5.1.2"><p id="dataartsstudio_02_0089__en-us_topic_0181281361_en-us_topic_0181281363_p3149113112204">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18.73%" id="mcps1.3.3.2.2.5.1.3"><p id="dataartsstudio_02_0089__en-us_topic_0181281361_en-us_topic_0181281363_p13149173119204">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="49.33%" id="mcps1.3.3.2.2.5.1.4"><p id="dataartsstudio_02_0089__en-us_topic_0181281361_en-us_topic_0181281363_p11149331122017">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dataartsstudio_02_0089__en-us_topic_0181281361_en-us_topic_0181281363_row174620159179"><td class="cellrowborder" valign="top" width="15.010000000000002%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dataartsstudio_02_0089__en-us_topic_0181281361_en-us_topic_0181281363_p1150183116205">workspace</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.93%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dataartsstudio_02_0089__en-us_topic_0181281361_en-us_topic_0181281363_p4150531152016">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.73%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dataartsstudio_02_0089__en-us_topic_0181281361_en-us_topic_0181281363_p181505317209">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.33%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dataartsstudio_02_0089__en-us_topic_0181281361_en-us_topic_0181281363_p169341251122511">Workspace ID.</p>
|
|
<ul id="dataartsstudio_02_0089__en-us_topic_0181281361_en-us_topic_0181281363_ul776685742514"><li id="dataartsstudio_02_0089__en-us_topic_0181281361_en-us_topic_0181281363_li076655782516">If this parameter is not set, data in the <strong id="dataartsstudio_02_0089__b17149123584619">default</strong> workspace is queried by default.</li><li id="dataartsstudio_02_0089__en-us_topic_0181281361_en-us_topic_0181281363_li788605918251">To query data in other workspaces, this header must be carried.</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dataartsstudio_02_0089__en-us_topic_0181281361_table19750184493418" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Parameters</caption><thead align="left"><tr id="dataartsstudio_02_0089__en-us_topic_0181281361_row1475134418345"><th align="left" class="cellrowborder" valign="top" width="21.51%" id="mcps1.3.3.3.2.5.1.1"><p id="dataartsstudio_02_0089__en-us_topic_0181281361_p1275244423417">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="10.45%" id="mcps1.3.3.3.2.5.1.2"><p id="dataartsstudio_02_0089__en-us_topic_0181281361_p1375504413341">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15.07%" id="mcps1.3.3.3.2.5.1.3"><p id="dataartsstudio_02_0089__en-us_topic_0181281361_p675774416349">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="52.96999999999999%" id="mcps1.3.3.3.2.5.1.4"><p id="dataartsstudio_02_0089__en-us_topic_0181281361_p475920448344">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dataartsstudio_02_0089__en-us_topic_0181281361_row2029125415917"><td class="cellrowborder" valign="top" width="21.51%" headers="mcps1.3.3.3.2.5.1.1 "><p id="dataartsstudio_02_0089__en-us_topic_0181281361_p174468521509">jobList</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.45%" headers="mcps1.3.3.3.2.5.1.2 "><p id="dataartsstudio_02_0089__en-us_topic_0181281361_p1844785205010">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.07%" headers="mcps1.3.3.3.2.5.1.3 "><p id="dataartsstudio_02_0089__en-us_topic_0181281361_p11447105213507">List</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.96999999999999%" headers="mcps1.3.3.3.2.5.1.4 "><p id="dataartsstudio_02_0089__en-us_topic_0181281361_p15879111511104">A list of jobs to be exported. A maximum of 100 jobs can be exported at a time.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dataartsstudio_02_0089__en-us_topic_0181281361_row179576283330"><td class="cellrowborder" valign="top" width="21.51%" headers="mcps1.3.3.3.2.5.1.1 "><p id="dataartsstudio_02_0089__en-us_topic_0181281361_p171511925125812">exportDepend</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.45%" headers="mcps1.3.3.3.2.5.1.2 "><p id="dataartsstudio_02_0089__en-us_topic_0181281361_p201518259586">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.07%" headers="mcps1.3.3.3.2.5.1.3 "><p id="dataartsstudio_02_0089__en-us_topic_0181281361_p18151142505819">boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.96999999999999%" headers="mcps1.3.3.3.2.5.1.4 "><p id="dataartsstudio_02_0089__en-us_topic_0181281361_p6152162555817">Specifies whether to export the scripts and resources that the job depends on.</p>
|
|
<p id="dataartsstudio_02_0089__en-us_topic_0181281361_p14667103111610">Default value: <strong id="dataartsstudio_02_0089__en-us_topic_0181281361_b7872102611441">true</strong></p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="dataartsstudio_02_0089__en-us_topic_0181281361_section18825164214554"><h4 class="sectiontitle">Response</h4><p id="dataartsstudio_02_0089__en-us_topic_0181281361_p3996154515519">The response message of batch exporting jobs is the same as that of exporting jobs. For details, see <a href="dataartsstudio_02_0088.html#dataartsstudio_02_0088__en-us_topic_0181281356_section561243517589">Response</a>.</p>
|
|
</div>
|
|
<div class="section" id="dataartsstudio_02_0089__en-us_topic_0181281361_section358155716277"><h4 class="sectiontitle">Example</h4><p id="dataartsstudio_02_0089__en-us_topic_0181281361_p5806133873213">Export two jobs named <strong id="dataartsstudio_02_0089__en-us_topic_0181281361_b11304173624414">job_batch</strong> and <strong id="dataartsstudio_02_0089__en-us_topic_0181281361_b1196212386441">job_stream</strong>.</p>
|
|
<ul id="dataartsstudio_02_0089__en-us_topic_0181281361_ul19401245123215"><li id="dataartsstudio_02_0089__en-us_topic_0181281361_li1540115456322">Request<pre class="screen" id="dataartsstudio_02_0089__en-us_topic_0181281361_screen1377816519562">POST /v1/b384b9e9ab9b4ee8994c8633aabc9505/jobs/batch-export
|
|
{
|
|
"jobList":["job_batch","job_stream"],
|
|
"exportDepend":true
|
|
}</pre>
|
|
</li></ul>
|
|
<ul id="dataartsstudio_02_0089__en-us_topic_0181281361_ul229791118277"><li id="dataartsstudio_02_0089__en-us_topic_0181281361_li1829741112279">Success response<p id="dataartsstudio_02_0089__en-us_topic_0181281361_p134899852916"><a name="dataartsstudio_02_0089__en-us_topic_0181281361_li1829741112279"></a><a name="en-us_topic_0181281361_li1829741112279"></a>The name of the exported file is <strong id="dataartsstudio_02_0089__en-us_topic_0181281361_b1910483318272">jobs.zip</strong>. The file structure after decompression is as follows:</p>
|
|
<pre class="screen" id="dataartsstudio_02_0089__en-us_topic_0181281361_screen1460519335312">jobs
|
|
+---job_batch
|
|
| dws_sql.script
|
|
| job_batch.job
|
|
\---job_stream
|
|
job_stream.job</pre>
|
|
<p id="dataartsstudio_02_0089__en-us_topic_0181281361_p282934420236"><strong id="dataartsstudio_02_0089__en-us_topic_0181281361_b43891955162720">job_batch.job</strong> and <strong id="dataartsstudio_02_0089__en-us_topic_0181281361_b149918582271">job_stream.job</strong> are job definition files.</p>
|
|
<p id="dataartsstudio_02_0089__en-us_topic_0181281361_p5297141112716"><strong id="dataartsstudio_02_0089__en-us_topic_0181281361_b3317121311457">dli_sql.script</strong> is the DLI SQL script file used by <strong id="dataartsstudio_02_0089__en-us_topic_0181281361_b03175131457">job_batch.job</strong>.</p>
|
|
</li></ul>
|
|
<ul id="dataartsstudio_02_0089__en-us_topic_0181281361_ul3725916596"><li id="dataartsstudio_02_0089__en-us_topic_0181281361_li313082312504">Failure response<p id="dataartsstudio_02_0089__en-us_topic_0181281361_p17868101111567"><a name="dataartsstudio_02_0089__en-us_topic_0181281361_li313082312504"></a><a name="en-us_topic_0181281361_li313082312504"></a>HTTP status code 400</p>
|
|
<pre class="screen" id="dataartsstudio_02_0089__en-us_topic_0181281361_screen2818105917308">{
|
|
"error_code":"DLF.3051",
|
|
"error_msg":"The request parameter is invalid."
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="dataartsstudio_02_0083.html">APIs to Be Taken Offline</a></div>
|
|
</div>
|
|
</div>
|
|
|