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>
185 lines
16 KiB
HTML
185 lines
16 KiB
HTML
<a name="dataartsstudio_02_0090"></a><a name="dataartsstudio_02_0090"></a>
|
|
|
|
<h1 class="topictitle1">Importing a Job</h1>
|
|
<div id="body0000001104654694"><div class="section" id="dataartsstudio_02_0090__en-us_topic_0181281374_section1738101810182"><h4 class="sectiontitle">Function</h4><p id="dataartsstudio_02_0090__en-us_topic_0181281374_p1912913467404">This API is used to import one or more job files from OBS to DLF.</p>
|
|
|
|
<div class="note" id="dataartsstudio_02_0090__en-us_topic_0181281374_note1769614414336"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="dataartsstudio_02_0090__en-us_topic_0181281374_p369784415333">Before using this API, store job files in OBS buckets.</p>
|
|
</div></div>
|
|
</div>
|
|
<div class="section" id="dataartsstudio_02_0090__en-us_topic_0181281374_section7934966101819"><h4 class="sectiontitle">URI</h4><ul id="dataartsstudio_02_0090__en-us_topic_0181281374_ul145591424184717"><li id="dataartsstudio_02_0090__en-us_topic_0181281374_li356152404715">URI format<p id="dataartsstudio_02_0090__en-us_topic_0181281374_p076674419427"><a name="dataartsstudio_02_0090__en-us_topic_0181281374_li356152404715"></a><a name="en-us_topic_0181281374_li356152404715"></a>POST /v1/{project_id}/jobs/import</p>
|
|
</li></ul>
|
|
<ul id="dataartsstudio_02_0090__en-us_topic_0181281374_ul1370917277482"><li id="dataartsstudio_02_0090__en-us_topic_0181281374_li170972720484">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dataartsstudio_02_0090__en-us_topic_0181281374_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_0090__en-us_topic_0181281374_en-us_topic_0093082049_row26974916181358"><th align="left" class="cellrowborder" valign="top" width="19.919999999999998%" id="mcps1.3.2.3.1.1.2.5.1.1"><p id="dataartsstudio_02_0090__en-us_topic_0181281374_en-us_topic_0093082049_p37484572181358">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="11.17%" id="mcps1.3.2.3.1.1.2.5.1.2"><p id="dataartsstudio_02_0090__en-us_topic_0181281374_en-us_topic_0093082049_p16351468181358">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15.61%" id="mcps1.3.2.3.1.1.2.5.1.3"><p id="dataartsstudio_02_0090__en-us_topic_0181281374_en-us_topic_0093082049_p49400541181358">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="53.300000000000004%" id="mcps1.3.2.3.1.1.2.5.1.4"><p id="dataartsstudio_02_0090__en-us_topic_0181281374_en-us_topic_0093082049_p42020886181358">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dataartsstudio_02_0090__en-us_topic_0181281374_en-us_topic_0093082049_row48248640181358"><td class="cellrowborder" valign="top" width="19.919999999999998%" headers="mcps1.3.2.3.1.1.2.5.1.1 "><p id="dataartsstudio_02_0090__en-us_topic_0181281374_en-us_topic_0093082049_p15825795181358">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.17%" headers="mcps1.3.2.3.1.1.2.5.1.2 "><p id="dataartsstudio_02_0090__en-us_topic_0181281374_en-us_topic_0093082049_p6820998181358">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.61%" headers="mcps1.3.2.3.1.1.2.5.1.3 "><p id="dataartsstudio_02_0090__en-us_topic_0181281374_en-us_topic_0093082049_p15629937181358">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.300000000000004%" headers="mcps1.3.2.3.1.1.2.5.1.4 "><p id="dataartsstudio_02_0090__en-us_topic_0181281374_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_0090__en-us_topic_0181281374_section10789431145710"><h4 class="sectiontitle">Request</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dataartsstudio_02_0090__en-us_topic_0181281374_table544435255017" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request parameters</caption><thead align="left"><tr id="dataartsstudio_02_0090__en-us_topic_0181281374_row444510523506"><th align="left" class="cellrowborder" valign="top" width="21.39%" id="mcps1.3.3.2.2.5.1.1"><p id="dataartsstudio_02_0090__en-us_topic_0181281374_p114461752155014">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="10.45%" id="mcps1.3.3.2.2.5.1.2"><p id="dataartsstudio_02_0090__en-us_topic_0181281374_p344615216509">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20.24%" id="mcps1.3.3.2.2.5.1.3"><p id="dataartsstudio_02_0090__en-us_topic_0181281374_p14446165285019">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="47.92%" id="mcps1.3.3.2.2.5.1.4"><p id="dataartsstudio_02_0090__en-us_topic_0181281374_p17446105245018">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dataartsstudio_02_0090__en-us_topic_0181281374_row54463527502"><td class="cellrowborder" valign="top" width="21.39%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dataartsstudio_02_0090__en-us_topic_0181281374_p174468521509">path</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.45%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dataartsstudio_02_0090__en-us_topic_0181281374_p1844785205010">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.24%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dataartsstudio_02_0090__en-us_topic_0181281374_p11447105213507">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="47.92%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dataartsstudio_02_0090__en-us_topic_0181281374_p16449152125010">If OBS is deployed, it refers to the OBS path for storing the job definition file. For the format of the job definition file, see the response message of the exported job, for example, obs://myBucket/jobs.zip.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dataartsstudio_02_0090__en-us_topic_0181281374_row18287105520520"><td class="cellrowborder" valign="top" width="21.39%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dataartsstudio_02_0090__en-us_topic_0181281374_p628745514521">params</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.45%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dataartsstudio_02_0090__en-us_topic_0181281374_p928710559523">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.24%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dataartsstudio_02_0090__en-us_topic_0181281374_p1228755515211">Map<String,String></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="47.92%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dataartsstudio_02_0090__en-us_topic_0181281374_p15288125555214">Public job parameter.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dataartsstudio_02_0090__en-us_topic_0181281374_row181978314717"><td class="cellrowborder" valign="top" width="21.39%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dataartsstudio_02_0090__en-us_topic_0181281374_p41973317714">sameNamePolicy</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.45%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dataartsstudio_02_0090__en-us_topic_0181281374_p19197203118712">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.24%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dataartsstudio_02_0090__en-us_topic_0181281374_p14197193116720">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="47.92%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dataartsstudio_02_0090__en-us_topic_0181281374_p15197203115712">Policy for specifying how to handle duplicate names. The options are as follows:</p>
|
|
<ul id="dataartsstudio_02_0090__en-us_topic_0181281374_ul63804411916"><li id="dataartsstudio_02_0090__en-us_topic_0181281374_li203808412912">SKIP</li><li id="dataartsstudio_02_0090__en-us_topic_0181281374_li1645325513364">OVERWRITE</li></ul>
|
|
<p id="dataartsstudio_02_0090__en-us_topic_0181281374_p0278195915368">Default value: <strong id="dataartsstudio_02_0090__en-us_topic_0181281374_b11701029185219">SKIP</strong></p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dataartsstudio_02_0090__en-us_topic_0181281374_row113083443014"><td class="cellrowborder" valign="top" width="21.39%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dataartsstudio_02_0090__en-us_topic_0181281374_p143086441804">jobsParam</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.45%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dataartsstudio_02_0090__en-us_topic_0181281374_p93081441013">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.24%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dataartsstudio_02_0090__en-us_topic_0181281374_p173085449011">List<JobParam></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="47.92%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dataartsstudio_02_0090__en-us_topic_0181281374_p123081244407">Job parameter. For details, see <a href="#dataartsstudio_02_0090__en-us_topic_0181281374_table5837184718449">Table 3</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dataartsstudio_02_0090__en-us_topic_0181281374_row124916814243"><td class="cellrowborder" valign="top" width="21.39%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dataartsstudio_02_0090__en-us_topic_0181281374_p14505814248">executeUser</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.45%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dataartsstudio_02_0090__en-us_topic_0181281374_p250118172418">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.24%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dataartsstudio_02_0090__en-us_topic_0181281374_p550198202413">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="47.92%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dataartsstudio_02_0090__en-us_topic_0181281374_p16506810244">User that executes the job.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="dataartsstudio_02_0090__en-us_topic_0181281374_table5837184718449"></a><a name="en-us_topic_0181281374_table5837184718449"></a><table cellpadding="4" cellspacing="0" summary="" id="dataartsstudio_02_0090__en-us_topic_0181281374_table5837184718449" frame="border" border="1" rules="all"><caption><b>Table 3 </b>JobParam parameters</caption><thead align="left"><tr id="dataartsstudio_02_0090__en-us_topic_0181281374_row9844174718440"><th align="left" class="cellrowborder" valign="top" width="21.26%" id="mcps1.3.3.3.2.5.1.1"><p id="dataartsstudio_02_0090__en-us_topic_0181281374_p148465471447">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="10.69%" id="mcps1.3.3.3.2.5.1.2"><p id="dataartsstudio_02_0090__en-us_topic_0181281374_p1484934764410">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20.53%" id="mcps1.3.3.3.2.5.1.3"><p id="dataartsstudio_02_0090__en-us_topic_0181281374_p11852104774415">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="47.52%" id="mcps1.3.3.3.2.5.1.4"><p id="dataartsstudio_02_0090__en-us_topic_0181281374_p985684704417">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dataartsstudio_02_0090__en-us_topic_0181281374_row7857647104419"><td class="cellrowborder" valign="top" width="21.26%" headers="mcps1.3.3.3.2.5.1.1 "><p id="dataartsstudio_02_0090__en-us_topic_0181281374_p14860947164416">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.69%" headers="mcps1.3.3.3.2.5.1.2 "><p id="dataartsstudio_02_0090__en-us_topic_0181281374_p1886244718449">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.53%" headers="mcps1.3.3.3.2.5.1.3 "><p id="dataartsstudio_02_0090__en-us_topic_0181281374_p586364715446">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="47.52%" headers="mcps1.3.3.3.2.5.1.4 "><p id="dataartsstudio_02_0090__en-us_topic_0181281374_p6866147164415">Job name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dataartsstudio_02_0090__en-us_topic_0181281374_row10867154744419"><td class="cellrowborder" valign="top" width="21.26%" headers="mcps1.3.3.3.2.5.1.1 "><p id="dataartsstudio_02_0090__en-us_topic_0181281374_p29221041622">params</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.69%" headers="mcps1.3.3.3.2.5.1.2 "><p id="dataartsstudio_02_0090__en-us_topic_0181281374_p29251413215">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.53%" headers="mcps1.3.3.3.2.5.1.3 "><p id="dataartsstudio_02_0090__en-us_topic_0181281374_p119251541216">Map<String,String></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="47.52%" headers="mcps1.3.3.3.2.5.1.4 "><p id="dataartsstudio_02_0090__en-us_topic_0181281374_p063414157216">Job parameter.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="dataartsstudio_02_0090__en-us_topic_0181281374_section1951037114216"><h4 class="sectiontitle">Response</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dataartsstudio_02_0090__en-us_topic_0181281374_table3593724210" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response parameter</caption><thead align="left"><tr id="dataartsstudio_02_0090__en-us_topic_0181281374_row2712373429"><th align="left" class="cellrowborder" valign="top" width="21.26%" id="mcps1.3.4.2.2.5.1.1"><p id="dataartsstudio_02_0090__en-us_topic_0181281374_p1591237154213">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="10.45%" id="mcps1.3.4.2.2.5.1.2"><p id="dataartsstudio_02_0090__en-us_topic_0181281374_p139103734216">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="13%" id="mcps1.3.4.2.2.5.1.3"><p id="dataartsstudio_02_0090__en-us_topic_0181281374_p01011371427">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="55.28999999999999%" id="mcps1.3.4.2.2.5.1.4"><p id="dataartsstudio_02_0090__en-us_topic_0181281374_p1812133774217">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dataartsstudio_02_0090__en-us_topic_0181281374_row1212837134220"><td class="cellrowborder" valign="top" width="21.26%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dataartsstudio_02_0090__en-us_topic_0181281374_p425327142211">taskId</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.45%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dataartsstudio_02_0090__en-us_topic_0181281374_p1427182742210">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dataartsstudio_02_0090__en-us_topic_0181281374_p62782722212">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.28999999999999%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dataartsstudio_02_0090__en-us_topic_0181281374_p228227192214">ID of the task. Used to call the API for querying system tasks to obtain the import status.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="dataartsstudio_02_0090__en-us_topic_0181281374_section358155716277"><h4 class="sectiontitle">Example</h4><p id="dataartsstudio_02_0090__en-us_topic_0181281374_p5806133873213">Import jobs from OBS to DLF. If there are jobs and scripts with the same name, overwrite them.</p>
|
|
<ul id="dataartsstudio_02_0090__en-us_topic_0181281374_ul19401245123215"><li id="dataartsstudio_02_0090__en-us_topic_0181281374_li1540115456322">Request<pre class="screen" id="dataartsstudio_02_0090__en-us_topic_0181281374_screen19433710217">POST /v1/b384b9e9ab9b4ee8994c8633aabc9505/jobs/import
|
|
{
|
|
"path": "obs://aaaaa/job_batch.zip",
|
|
"sameNamePolicy": "OVERWRITE",
|
|
"jobsParam": [{
|
|
"name": "job_batch",
|
|
"params": {
|
|
"streamName": "dis-AHTr"
|
|
}
|
|
}]
|
|
}</pre>
|
|
</li></ul>
|
|
<ul id="dataartsstudio_02_0090__en-us_topic_0181281374_ul1593065043218"><li id="dataartsstudio_02_0090__en-us_topic_0181281374_li093015019327">Success response<div class="p" id="dataartsstudio_02_0090__en-us_topic_0181281374_p63991158939"><a name="dataartsstudio_02_0090__en-us_topic_0181281374_li093015019327"></a><a name="en-us_topic_0181281374_li093015019327"></a>HTTP status code 200<pre class="screen" id="dataartsstudio_02_0090__en-us_topic_0181281374_screen15502056137">{
|
|
"taskId":"008aae2e675933c7016759418e870000"
|
|
}</pre>
|
|
</div>
|
|
</li><li id="dataartsstudio_02_0090__en-us_topic_0181281374_li697361214553">Failure response<p id="dataartsstudio_02_0090__en-us_topic_0181281374_p17868101111567"><a name="dataartsstudio_02_0090__en-us_topic_0181281374_li697361214553"></a><a name="en-us_topic_0181281374_li697361214553"></a>HTTP status code 400</p>
|
|
<pre class="screen" id="dataartsstudio_02_0090__en-us_topic_0181281374_screen31171971269">{
|
|
"error_code":"DLF.0815",
|
|
"error_msg":"Fail to read OBS file."
|
|
}</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>
|
|
|