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>
172 lines
17 KiB
HTML
172 lines
17 KiB
HTML
<a name="dataartsstudio_02_0088"></a><a name="dataartsstudio_02_0088"></a>
|
|
|
|
<h1 class="topictitle1">Exporting a Job</h1>
|
|
<div id="body0000001151254681"><div class="section" id="dataartsstudio_02_0088__en-us_topic_0181281356_section1738101810182"><h4 class="sectiontitle">Function</h4><p id="dataartsstudio_02_0088__en-us_topic_0181281356_p1912913467404">This API is used to export a job, including job definitions, job dependency scripts, and CDM job definitions.</p>
|
|
</div>
|
|
<div class="section" id="dataartsstudio_02_0088__en-us_topic_0181281356_section7934966101819"><h4 class="sectiontitle">URI</h4><ul id="dataartsstudio_02_0088__en-us_topic_0181281356_ul145591424184717"><li id="dataartsstudio_02_0088__en-us_topic_0181281356_li356152404715">URI format<p id="dataartsstudio_02_0088__en-us_topic_0181281356_p076674419427"><a name="dataartsstudio_02_0088__en-us_topic_0181281356_li356152404715"></a><a name="en-us_topic_0181281356_li356152404715"></a>POST /v1/{project_id}/jobs/{name}/export</p>
|
|
</li></ul>
|
|
<ul id="dataartsstudio_02_0088__en-us_topic_0181281356_ul1370917277482"><li id="dataartsstudio_02_0088__en-us_topic_0181281356_li170972720484">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dataartsstudio_02_0088__en-us_topic_0181281356_en-us_topic_0093082049_table46023801181358" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameters</caption><thead align="left"><tr id="dataartsstudio_02_0088__en-us_topic_0181281356_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_0088__en-us_topic_0181281356_en-us_topic_0093082049_p37484572181358">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="10.66%" id="mcps1.3.2.3.1.1.2.5.1.2"><p id="dataartsstudio_02_0088__en-us_topic_0181281356_en-us_topic_0093082049_p16351468181358">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16.12%" id="mcps1.3.2.3.1.1.2.5.1.3"><p id="dataartsstudio_02_0088__en-us_topic_0181281356_en-us_topic_0093082049_p49400541181358">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="53.04%" id="mcps1.3.2.3.1.1.2.5.1.4"><p id="dataartsstudio_02_0088__en-us_topic_0181281356_en-us_topic_0093082049_p42020886181358">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dataartsstudio_02_0088__en-us_topic_0181281356_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_0088__en-us_topic_0181281356_en-us_topic_0093082049_p15825795181358">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.66%" headers="mcps1.3.2.3.1.1.2.5.1.2 "><p id="dataartsstudio_02_0088__en-us_topic_0181281356_en-us_topic_0093082049_p6820998181358">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.12%" headers="mcps1.3.2.3.1.1.2.5.1.3 "><p id="dataartsstudio_02_0088__en-us_topic_0181281356_en-us_topic_0093082049_p15629937181358">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.04%" headers="mcps1.3.2.3.1.1.2.5.1.4 "><p id="dataartsstudio_02_0088__en-us_topic_0181281356_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>
|
|
<tr id="dataartsstudio_02_0088__en-us_topic_0181281356_row29566273563"><td class="cellrowborder" valign="top" width="20.18%" headers="mcps1.3.2.3.1.1.2.5.1.1 "><p id="dataartsstudio_02_0088__en-us_topic_0181281356_p49561027135617">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.66%" headers="mcps1.3.2.3.1.1.2.5.1.2 "><p id="dataartsstudio_02_0088__en-us_topic_0181281356_p1195613271566">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.12%" headers="mcps1.3.2.3.1.1.2.5.1.3 "><p id="dataartsstudio_02_0088__en-us_topic_0181281356_p421414825613">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.04%" headers="mcps1.3.2.3.1.1.2.5.1.4 "><p id="dataartsstudio_02_0088__en-us_topic_0181281356_p395617274566">Job name.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="dataartsstudio_02_0088__en-us_topic_0181281356_section10789431145710"><h4 class="sectiontitle">Request</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dataartsstudio_02_0088__en-us_topic_0181281356_table25071810112414" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameter</caption><thead align="left"><tr id="dataartsstudio_02_0088__en-us_topic_0181281356_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_0088__en-us_topic_0181281356_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_0088__en-us_topic_0181281356_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_0088__en-us_topic_0181281356_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_0088__en-us_topic_0181281356_en-us_topic_0181281363_p11149331122017">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dataartsstudio_02_0088__en-us_topic_0181281356_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_0088__en-us_topic_0181281356_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_0088__en-us_topic_0181281356_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_0088__en-us_topic_0181281356_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_0088__en-us_topic_0181281356_en-us_topic_0181281363_p169341251122511">Workspace ID.</p>
|
|
<ul id="dataartsstudio_02_0088__en-us_topic_0181281356_en-us_topic_0181281363_ul776685742514"><li id="dataartsstudio_02_0088__en-us_topic_0181281356_en-us_topic_0181281363_li076655782516">If this parameter is not set, data in the <strong id="dataartsstudio_02_0088__b13444113011464">default</strong> workspace is queried by default.</li><li id="dataartsstudio_02_0088__en-us_topic_0181281356_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_0088__en-us_topic_0181281356_table544435255017" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Parameter</caption><thead align="left"><tr id="dataartsstudio_02_0088__en-us_topic_0181281356_row444510523506"><th align="left" class="cellrowborder" valign="top" width="21.75%" id="mcps1.3.3.3.2.5.1.1"><p id="dataartsstudio_02_0088__en-us_topic_0181281356_p114461752155014">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_0088__en-us_topic_0181281356_p344615216509">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15.190000000000001%" id="mcps1.3.3.3.2.5.1.3"><p id="dataartsstudio_02_0088__en-us_topic_0181281356_p14446165285019">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="52.61%" id="mcps1.3.3.3.2.5.1.4"><p id="dataartsstudio_02_0088__en-us_topic_0181281356_p17446105245018">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dataartsstudio_02_0088__en-us_topic_0181281356_row54463527502"><td class="cellrowborder" valign="top" width="21.75%" headers="mcps1.3.3.3.2.5.1.1 "><p id="dataartsstudio_02_0088__en-us_topic_0181281356_p174468521509">exportDepend</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.45%" headers="mcps1.3.3.3.2.5.1.2 "><p id="dataartsstudio_02_0088__en-us_topic_0181281356_p45410281415">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.190000000000001%" headers="mcps1.3.3.3.2.5.1.3 "><p id="dataartsstudio_02_0088__en-us_topic_0181281356_p16412235111">boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.61%" headers="mcps1.3.3.3.2.5.1.4 "><p id="dataartsstudio_02_0088__en-us_topic_0181281356_p11826184016116">Specifies whether to export the scripts and resources that the job depends on.</p>
|
|
<p id="dataartsstudio_02_0088__en-us_topic_0181281356_p98261940414">Default value: true</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="dataartsstudio_02_0088__en-us_topic_0181281356_section561243517589"><a name="dataartsstudio_02_0088__en-us_topic_0181281356_section561243517589"></a><a name="en-us_topic_0181281356_section561243517589"></a><h4 class="sectiontitle">Response</h4><p id="dataartsstudio_02_0088__en-us_topic_0181281356_p787233382411">The value of <strong id="dataartsstudio_02_0088__en-us_topic_0181281356_b12932183824116">Content-Type</strong> in the response message is <strong id="dataartsstudio_02_0088__en-us_topic_0181281356_b1933123844113">application/octet-stream</strong> that needs to be converted into a file. For details, see <a href="dataartsstudio_02_0317.html">Parsing a Stream in a Response Message</a>. Response messages are compressed as a file. The file name format is <strong id="dataartsstudio_02_0088__en-us_topic_0181281356_b124462414437">DLF_</strong><em id="dataartsstudio_02_0088__en-us_topic_0181281356_i6174539104319">job_name</em><strong id="dataartsstudio_02_0088__en-us_topic_0181281356_b170133611432">.zip</strong>. The file directory is as follows:</p>
|
|
<pre class="screen" id="dataartsstudio_02_0088__en-us_topic_0181281356_screen10761137172910">jobs
|
|
├─{job_name}.job
|
|
scripts
|
|
├─{script_name}.script
|
|
resources
|
|
├─{resource_name}.resource</pre>
|
|
<p id="dataartsstudio_02_0088__en-us_topic_0181281356_p78792534290"><a href="#dataartsstudio_02_0088__en-us_topic_0181281356_table115125816213">Table 4</a> describes the file directory parameters.</p>
|
|
|
|
<div class="tablenoborder"><a name="dataartsstudio_02_0088__en-us_topic_0181281356_table115125816213"></a><a name="en-us_topic_0181281356_table115125816213"></a><table cellpadding="4" cellspacing="0" summary="" id="dataartsstudio_02_0088__en-us_topic_0181281356_table115125816213" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response parameters</caption><thead align="left"><tr id="dataartsstudio_02_0088__en-us_topic_0181281356_row417125815214"><th align="left" class="cellrowborder" valign="top" width="21.63%" id="mcps1.3.4.5.2.5.1.1"><p id="dataartsstudio_02_0088__en-us_topic_0181281356_p131713581926">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="10.33%" id="mcps1.3.4.5.2.5.1.2"><p id="dataartsstudio_02_0088__en-us_topic_0181281356_p171815581224">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15.07%" id="mcps1.3.4.5.2.5.1.3"><p id="dataartsstudio_02_0088__en-us_topic_0181281356_p171810581924">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="52.96999999999999%" id="mcps1.3.4.5.2.5.1.4"><p id="dataartsstudio_02_0088__en-us_topic_0181281356_p1219195810217">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dataartsstudio_02_0088__en-us_topic_0181281356_row102220581627"><td class="cellrowborder" valign="top" width="21.63%" headers="mcps1.3.4.5.2.5.1.1 "><p id="dataartsstudio_02_0088__en-us_topic_0181281356_p15221958326">job_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.33%" headers="mcps1.3.4.5.2.5.1.2 "><p id="dataartsstudio_02_0088__en-us_topic_0181281356_p92219581324">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.07%" headers="mcps1.3.4.5.2.5.1.3 "><p id="dataartsstudio_02_0088__en-us_topic_0181281356_p523145814212">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.96999999999999%" headers="mcps1.3.4.5.2.5.1.4 "><p id="dataartsstudio_02_0088__en-us_topic_0181281356_p17231858527">Job name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dataartsstudio_02_0088__en-us_topic_0181281356_row03461333512"><td class="cellrowborder" valign="top" width="21.63%" headers="mcps1.3.4.5.2.5.1.1 "><p id="dataartsstudio_02_0088__en-us_topic_0181281356_p134613316519">script_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.33%" headers="mcps1.3.4.5.2.5.1.2 "><p id="dataartsstudio_02_0088__en-us_topic_0181281356_p43461832513">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.07%" headers="mcps1.3.4.5.2.5.1.3 "><p id="dataartsstudio_02_0088__en-us_topic_0181281356_p93461335518">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.96999999999999%" headers="mcps1.3.4.5.2.5.1.4 "><p id="dataartsstudio_02_0088__en-us_topic_0181281356_p63461132514">Name of the script that the job depends on.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dataartsstudio_02_0088__en-us_topic_0181281356_row1329751776"><td class="cellrowborder" valign="top" width="21.63%" headers="mcps1.3.4.5.2.5.1.1 "><p id="dataartsstudio_02_0088__en-us_topic_0181281356_p16329151070">resource_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.33%" headers="mcps1.3.4.5.2.5.1.2 "><p id="dataartsstudio_02_0088__en-us_topic_0181281356_p398301918713">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.07%" headers="mcps1.3.4.5.2.5.1.3 "><p id="dataartsstudio_02_0088__en-us_topic_0181281356_p113291459718">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.96999999999999%" headers="mcps1.3.4.5.2.5.1.4 "><p id="dataartsstudio_02_0088__en-us_topic_0181281356_p143295519717">Name of the resource that the job depends on.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<ul id="dataartsstudio_02_0088__en-us_topic_0181281356_ul1860861715576"><li id="dataartsstudio_02_0088__en-us_topic_0181281356_li8608131765712">{job_name}.job<p id="dataartsstudio_02_0088__en-us_topic_0181281356_p317115918580"><a name="dataartsstudio_02_0088__en-us_topic_0181281356_li8608131765712"></a><a name="en-us_topic_0181281356_li8608131765712"></a>The parameters in the file are the same as the request parameters of the API for creating a job. For details, see <a href="dataartsstudio_02_0084.html">Creating a Job</a>.</p>
|
|
</li><li id="dataartsstudio_02_0088__en-us_topic_0181281356_li209122352584">{script_name}.script<p id="dataartsstudio_02_0088__en-us_topic_0181281356_p166871324115912"><a name="dataartsstudio_02_0088__en-us_topic_0181281356_li209122352584"></a><a name="en-us_topic_0181281356_li209122352584"></a>The parameters in the file are the same as the request parameters of the API for creating a resource. For details, see <a href="dataartsstudio_02_0097.html">Creating a Script</a>.</p>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="dataartsstudio_02_0088__en-us_topic_0181281356_section358155716277"><h4 class="sectiontitle">Example</h4><p id="dataartsstudio_02_0088__en-us_topic_0181281356_p5806133873213">Export job <strong id="dataartsstudio_02_0088__en-us_topic_0181281356_b49381223171915">myJob</strong>.</p>
|
|
<ul id="dataartsstudio_02_0088__en-us_topic_0181281356_ul19401245123215"><li id="dataartsstudio_02_0088__en-us_topic_0181281356_li1540115456322">Request<pre class="screen" id="dataartsstudio_02_0088__en-us_topic_0181281356_screen99427376533">POST /v1/b384b9e9ab9b4ee8994c8633aabc9505/jobs/myJob/export
|
|
{
|
|
"exportDepend":true
|
|
}</pre>
|
|
</li></ul>
|
|
<ul id="dataartsstudio_02_0088__en-us_topic_0181281356_ul1593065043218"><li id="dataartsstudio_02_0088__en-us_topic_0181281356_li093015019327">Success response<p id="dataartsstudio_02_0088__p317651175616"><a name="dataartsstudio_02_0088__en-us_topic_0181281356_li093015019327"></a><a name="en-us_topic_0181281356_li093015019327"></a>HTTP status code 200</p>
|
|
<p id="dataartsstudio_02_0088__en-us_topic_0181281356_p134899852916">The name of the exported file is <strong id="dataartsstudio_02_0088__en-us_topic_0181281356_b1254917404198">DLF_myJob.zip</strong>. The file structure after decompression is as follows:</p>
|
|
<pre class="screen" id="dataartsstudio_02_0088__en-us_topic_0181281356_screen1324518418311">jobs
|
|
├─myJob.job
|
|
scripts
|
|
├─CS_PROCESS_TRIP.script
|
|
├─TRIP_RAW_STANDARD.script</pre>
|
|
</li></ul>
|
|
<ul id="dataartsstudio_02_0088__en-us_topic_0181281356_ul1963180192413"><li id="dataartsstudio_02_0088__en-us_topic_0181281356_li313082312504">Failure response<p id="dataartsstudio_02_0088__en-us_topic_0181281356_p17868101111567"><a name="dataartsstudio_02_0088__en-us_topic_0181281356_li313082312504"></a><a name="en-us_topic_0181281356_li313082312504"></a>HTTP status code 400</p>
|
|
<pre class="screen" id="dataartsstudio_02_0088__en-us_topic_0181281356_screen2818105917308">{
|
|
"error_code":"DLF.0100",
|
|
"error_msg":"The job does not exists."
|
|
}</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>
|
|
|