forked from docs/doc-exports
Xiong, Chen Xiao
14a6d65e8c
Reviewed-by: Pruthi, Vineet <vineet.pruthi@t-systems.com> Co-authored-by: Xiong, Chen Xiao <chenxiaoxiong@huawei.com> Co-committed-by: Xiong, Chen Xiao <chenxiaoxiong@huawei.com>
214 lines
17 KiB
HTML
214 lines
17 KiB
HTML
<a name="dataartsstudio_02_0063"></a><a name="dataartsstudio_02_0063"></a>
|
|
|
|
<h1 class="topictitle1">Viewing a Job File</h1>
|
|
<div id="body0000001151174553"><div class="section" id="dataartsstudio_02_0063__en-us_topic_0181281317_section1738101810182"><h4 class="sectiontitle">Function</h4><p id="dataartsstudio_02_0063__en-us_topic_0181281317_p1912913467404">This API is used to check whether there are jobs and scripts in the job file to be imported from OBS to DLF.</p>
|
|
</div>
|
|
<div class="section" id="dataartsstudio_02_0063__en-us_topic_0181281317_section7934966101819"><h4 class="sectiontitle">URI</h4><ul id="dataartsstudio_02_0063__en-us_topic_0181281317_ul145591424184717"><li id="dataartsstudio_02_0063__en-us_topic_0181281317_li356152404715">URI format<p id="dataartsstudio_02_0063__en-us_topic_0181281317_p076674419427"><a name="dataartsstudio_02_0063__en-us_topic_0181281317_li356152404715"></a><a name="en-us_topic_0181281317_li356152404715"></a>POST /v1/{project_id}/jobs/check-file</p>
|
|
</li></ul>
|
|
<ul id="dataartsstudio_02_0063__en-us_topic_0181281317_ul1370917277482"><li id="dataartsstudio_02_0063__en-us_topic_0181281317_li170972720484">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dataartsstudio_02_0063__en-us_topic_0181281317_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_0063__en-us_topic_0181281317_en-us_topic_0093082049_row26974916181358"><th align="left" class="cellrowborder" valign="top" width="20.05%" id="mcps1.3.2.3.1.1.2.5.1.1"><p id="dataartsstudio_02_0063__en-us_topic_0181281317_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_0063__en-us_topic_0181281317_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_0063__en-us_topic_0181281317_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_0063__en-us_topic_0181281317_en-us_topic_0093082049_p42020886181358">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dataartsstudio_02_0063__en-us_topic_0181281317_en-us_topic_0093082049_row48248640181358"><td class="cellrowborder" valign="top" width="20.05%" headers="mcps1.3.2.3.1.1.2.5.1.1 "><p id="dataartsstudio_02_0063__en-us_topic_0181281317_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_0063__en-us_topic_0181281317_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_0063__en-us_topic_0181281317_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_0063__en-us_topic_0181281317_p8672138175612">Project ID. For details about how to obtain a project ID, see <a href="projectid_accountid.html">Project ID and Account ID</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="dataartsstudio_02_0063__en-us_topic_0181281317_section10789431145710"><h4 class="sectiontitle">Request Parameters</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dataartsstudio_02_0063__en-us_topic_0181281317_table19750184493418" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request parameters</caption><thead align="left"><tr id="dataartsstudio_02_0063__en-us_topic_0181281317_row1475134418345"><th align="left" class="cellrowborder" valign="top" width="21.75%" id="mcps1.3.3.2.2.5.1.1"><p id="dataartsstudio_02_0063__en-us_topic_0181281317_p1275244423417">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="10.209999999999999%" id="mcps1.3.3.2.2.5.1.2"><p id="dataartsstudio_02_0063__en-us_topic_0181281317_p1375504413341">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="14.95%" id="mcps1.3.3.2.2.5.1.3"><p id="dataartsstudio_02_0063__en-us_topic_0181281317_p675774416349">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="53.09%" id="mcps1.3.3.2.2.5.1.4"><p id="dataartsstudio_02_0063__en-us_topic_0181281317_p475920448344">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dataartsstudio_02_0063__en-us_topic_0181281317_row2029125415917"><td class="cellrowborder" valign="top" width="21.75%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dataartsstudio_02_0063__en-us_topic_0181281317_p174468521509">path</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.209999999999999%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dataartsstudio_02_0063__en-us_topic_0181281317_p1844785205010">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.95%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dataartsstudio_02_0063__en-us_topic_0181281317_p11447105213507">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.09%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dataartsstudio_02_0063__en-us_topic_0181281317_p15879111511104">If OBS is deployed, the job definition file is stored on OBS, for example, obs://myBucket/jobs.zip.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="dataartsstudio_02_0063__en-us_topic_0181281317_section1153315412178"><h4 class="sectiontitle">Response Parameters</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dataartsstudio_02_0063__en-us_topic_0181281317_table48721644195616" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response parameters</caption><thead align="left"><tr id="dataartsstudio_02_0063__en-us_topic_0181281317_row16874184435610"><th align="left" class="cellrowborder" valign="top" width="21.51%" id="mcps1.3.4.2.2.5.1.1"><p id="dataartsstudio_02_0063__en-us_topic_0181281317_p17875644155615">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="10.57%" id="mcps1.3.4.2.2.5.1.2"><p id="dataartsstudio_02_0063__en-us_topic_0181281317_p1387674417561">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15.310000000000002%" id="mcps1.3.4.2.2.5.1.3"><p id="dataartsstudio_02_0063__en-us_topic_0181281317_p0876174415568">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="52.61%" id="mcps1.3.4.2.2.5.1.4"><p id="dataartsstudio_02_0063__en-us_topic_0181281317_p1188011442563">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dataartsstudio_02_0063__en-us_topic_0181281317_row128816445569"><td class="cellrowborder" valign="top" width="21.51%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dataartsstudio_02_0063__en-us_topic_0181281317_p1688113446568">jobs</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.57%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dataartsstudio_02_0063__en-us_topic_0181281317_p1288119443563">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.310000000000002%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dataartsstudio_02_0063__en-us_topic_0181281317_p12882194418569">List<Job></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.61%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dataartsstudio_02_0063__en-us_topic_0181281317_p7884174410563">Job information. For details, see <a href="#dataartsstudio_02_0063__en-us_topic_0181281317_table165346413179">Table 4</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dataartsstudio_02_0063__en-us_topic_0181281317_row44191008175"><td class="cellrowborder" valign="top" width="21.51%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dataartsstudio_02_0063__en-us_topic_0181281317_p0420308178">scripts</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.57%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dataartsstudio_02_0063__en-us_topic_0181281317_p8420100121718">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.310000000000002%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dataartsstudio_02_0063__en-us_topic_0181281317_p34202041718">List<Script></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.61%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dataartsstudio_02_0063__en-us_topic_0181281317_p442012010173">Script information. For details, see <a href="#dataartsstudio_02_0063__en-us_topic_0181281317_table1996985891715">Table 5</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="dataartsstudio_02_0063__en-us_topic_0181281317_table165346413179"></a><a name="en-us_topic_0181281317_table165346413179"></a><table cellpadding="4" cellspacing="0" summary="" id="dataartsstudio_02_0063__en-us_topic_0181281317_table165346413179" frame="border" border="1" rules="all"><caption><b>Table 4 </b>job data structure description</caption><thead align="left"><tr id="dataartsstudio_02_0063__en-us_topic_0181281317_row55371741161719"><th align="left" class="cellrowborder" valign="top" width="21.63%" id="mcps1.3.4.3.2.5.1.1"><p id="dataartsstudio_02_0063__en-us_topic_0181281317_p135382041191712">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="10.45%" id="mcps1.3.4.3.2.5.1.2"><p id="dataartsstudio_02_0063__en-us_topic_0181281317_p354024120178">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="19.68%" id="mcps1.3.4.3.2.5.1.3"><p id="dataartsstudio_02_0063__en-us_topic_0181281317_p165401417179">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="48.24%" id="mcps1.3.4.3.2.5.1.4"><p id="dataartsstudio_02_0063__en-us_topic_0181281317_p1654064151716">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dataartsstudio_02_0063__en-us_topic_0181281317_row6544174111714"><td class="cellrowborder" valign="top" width="21.63%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dataartsstudio_02_0063__en-us_topic_0181281317_p8545441201715">params</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.45%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dataartsstudio_02_0063__en-us_topic_0181281317_p55451141191716">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.68%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dataartsstudio_02_0063__en-us_topic_0181281317_p19547194141717">Map<String,String></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.24%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dataartsstudio_02_0063__en-us_topic_0181281317_p1554824101714">Job parameter.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dataartsstudio_02_0063__en-us_topic_0181281317_row5789142114447"><td class="cellrowborder" valign="top" width="21.63%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dataartsstudio_02_0063__en-us_topic_0181281317_p679019215448">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.45%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dataartsstudio_02_0063__en-us_topic_0181281317_p197902021204417">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.68%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dataartsstudio_02_0063__en-us_topic_0181281317_p9790621124413">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.24%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dataartsstudio_02_0063__en-us_topic_0181281317_p1379012144412">Job name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dataartsstudio_02_0063__en-us_topic_0181281317_row54511150151812"><td class="cellrowborder" valign="top" width="21.63%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dataartsstudio_02_0063__en-us_topic_0181281317_p0451155014187">path</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.45%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dataartsstudio_02_0063__en-us_topic_0181281317_p445195014182">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.68%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dataartsstudio_02_0063__en-us_topic_0181281317_p1945135017181">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.24%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dataartsstudio_02_0063__en-us_topic_0181281317_p13451350101819">Path of the job</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="dataartsstudio_02_0063__en-us_topic_0181281317_table1996985891715"></a><a name="en-us_topic_0181281317_table1996985891715"></a><table cellpadding="4" cellspacing="0" summary="" id="dataartsstudio_02_0063__en-us_topic_0181281317_table1996985891715" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Data structure description of <strong id="dataartsstudio_02_0063__en-us_topic_0181281317_b3275399491">Script</strong></caption><thead align="left"><tr id="dataartsstudio_02_0063__en-us_topic_0181281317_row15970135813179"><th align="left" class="cellrowborder" valign="top" width="21.630000000000003%" id="mcps1.3.4.4.2.5.1.1"><p id="dataartsstudio_02_0063__en-us_topic_0181281317_p1197025818175">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="10.450000000000001%" id="mcps1.3.4.4.2.5.1.2"><p id="dataartsstudio_02_0063__en-us_topic_0181281317_p149701587177">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="14.950000000000003%" id="mcps1.3.4.4.2.5.1.3"><p id="dataartsstudio_02_0063__en-us_topic_0181281317_p497055815176">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="52.970000000000006%" id="mcps1.3.4.4.2.5.1.4"><p id="dataartsstudio_02_0063__en-us_topic_0181281317_p19970135811177">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dataartsstudio_02_0063__en-us_topic_0181281317_row15970135891714"><td class="cellrowborder" valign="top" width="21.630000000000003%" headers="mcps1.3.4.4.2.5.1.1 "><p id="dataartsstudio_02_0063__en-us_topic_0181281317_p0970858191717">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.450000000000001%" headers="mcps1.3.4.4.2.5.1.2 "><p id="dataartsstudio_02_0063__en-us_topic_0181281317_p1097025801720">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.950000000000003%" headers="mcps1.3.4.4.2.5.1.3 "><p id="dataartsstudio_02_0063__en-us_topic_0181281317_p2970125811716">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.970000000000006%" headers="mcps1.3.4.4.2.5.1.4 "><p id="dataartsstudio_02_0063__en-us_topic_0181281317_p18970105841711">Script name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dataartsstudio_02_0063__en-us_topic_0181281317_row116151930201810"><td class="cellrowborder" valign="top" width="21.630000000000003%" headers="mcps1.3.4.4.2.5.1.1 "><p id="dataartsstudio_02_0063__en-us_topic_0181281317_p1161618301181">path</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.450000000000001%" headers="mcps1.3.4.4.2.5.1.2 "><p id="dataartsstudio_02_0063__en-us_topic_0181281317_p136166306188">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.950000000000003%" headers="mcps1.3.4.4.2.5.1.3 "><p id="dataartsstudio_02_0063__en-us_topic_0181281317_p661618305187">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.970000000000006%" headers="mcps1.3.4.4.2.5.1.4 "><p id="dataartsstudio_02_0063__en-us_topic_0181281317_p11616203021816">Path of the script.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="dataartsstudio_02_0063__section59871311173114"><h4 class="sectiontitle">Example Request</h4><div class="p" id="dataartsstudio_02_0063__p168511613173119">Query the parameter definitions in the job file on OBS. The OBS path of the job definition file is <strong id="dataartsstudio_02_0063__b5175101414547">obs://aaaaa/DLF_myJob.zip</strong>.<pre class="screen" id="dataartsstudio_02_0063__screen198519137313">POST /v1/b384b9e9ab9b4ee8994c8633aabc9505/jobs/check-file
|
|
{
|
|
"path": "obs://aaaaa/DLF_myJob.zip"
|
|
}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="dataartsstudio_02_0063__en-us_topic_0181281317_section358155716277"><h4 class="sectiontitle">Example Response</h4><ul id="dataartsstudio_02_0063__en-us_topic_0181281317_ul29417108586"><li id="dataartsstudio_02_0063__en-us_topic_0181281317_li6941810135819">Success response<pre class="screen" id="dataartsstudio_02_0063__en-us_topic_0181281317_screen136927111700">{
|
|
"jobs":[
|
|
{
|
|
"name":"test",
|
|
"path":"/test",
|
|
"params":{
|
|
"ddd":"dddd"
|
|
}
|
|
},
|
|
{
|
|
"name":"test1",
|
|
"path":"/test",
|
|
"params":{
|
|
"ddd":"dddd"
|
|
}
|
|
}
|
|
],
|
|
"scripts":[
|
|
{
|
|
"name":"script1",
|
|
"path":"/path1"
|
|
},
|
|
{
|
|
"name":"script2",
|
|
"path":"/path1"
|
|
}
|
|
]
|
|
}</pre>
|
|
</li></ul>
|
|
<ul id="dataartsstudio_02_0063__en-us_topic_0181281317_ul13982950153019"><li id="dataartsstudio_02_0063__en-us_topic_0181281317_li149821505305">Failure response<p id="dataartsstudio_02_0063__en-us_topic_0181281317_p17868101111567"><a name="dataartsstudio_02_0063__en-us_topic_0181281317_li149821505305"></a><a name="en-us_topic_0181281317_li149821505305"></a>HTTP status code 400</p>
|
|
<pre class="screen" id="dataartsstudio_02_0063__en-us_topic_0181281317_screen470132612014">{
|
|
"error_code":"DLF.0815",
|
|
"error_msg":"Fail to read OBS file."
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="dataartsstudio_02_0063__en-us_topic_0181281317_section23551434175216"><h4 class="sectiontitle">Status Codes</h4><p id="dataartsstudio_02_0063__en-us_topic_0181281317_p12269139175219">See <a href="dataartsstudio_02_0310.html">Status Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="dataartsstudio_02_0062.html">Job Development APIs</a></div>
|
|
</div>
|
|
</div>
|
|
|