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>
142 lines
13 KiB
HTML
142 lines
13 KiB
HTML
<a name="dataartsstudio_02_0092"></a><a name="dataartsstudio_02_0092"></a>
|
|
|
|
<h1 class="topictitle1">Starting a Job</h1>
|
|
<div id="body0000001151054643"><div class="section" id="dataartsstudio_02_0092__en-us_topic_0181281337_section1738101810182"><h4 class="sectiontitle">Function</h4><p id="dataartsstudio_02_0092__en-us_topic_0181281337_p1912913467404">This API is used to start a job.</p>
|
|
</div>
|
|
<div class="section" id="dataartsstudio_02_0092__en-us_topic_0181281337_section7934966101819"><h4 class="sectiontitle">URI</h4><ul id="dataartsstudio_02_0092__en-us_topic_0181281337_ul145591424184717"><li id="dataartsstudio_02_0092__en-us_topic_0181281337_li356152404715">URI format<p id="dataartsstudio_02_0092__en-us_topic_0181281337_p076674419427"><a name="dataartsstudio_02_0092__en-us_topic_0181281337_li356152404715"></a><a name="en-us_topic_0181281337_li356152404715"></a>POST /v1/{project_id}/jobs/{name}/start</p>
|
|
</li></ul>
|
|
<ul id="dataartsstudio_02_0092__en-us_topic_0181281337_ul1370917277482"><li id="dataartsstudio_02_0092__en-us_topic_0181281337_li170972720484">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dataartsstudio_02_0092__en-us_topic_0181281337_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_0092__en-us_topic_0181281337_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_0092__en-us_topic_0181281337_en-us_topic_0093082049_p37484572181358">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="11.04%" id="mcps1.3.2.3.1.1.2.5.1.2"><p id="dataartsstudio_02_0092__en-us_topic_0181281337_en-us_topic_0093082049_p16351468181358">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17.01%" id="mcps1.3.2.3.1.1.2.5.1.3"><p id="dataartsstudio_02_0092__en-us_topic_0181281337_en-us_topic_0093082049_p49400541181358">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="52.03%" id="mcps1.3.2.3.1.1.2.5.1.4"><p id="dataartsstudio_02_0092__en-us_topic_0181281337_en-us_topic_0093082049_p42020886181358">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dataartsstudio_02_0092__en-us_topic_0181281337_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_0092__en-us_topic_0181281337_en-us_topic_0093082049_p15825795181358">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.04%" headers="mcps1.3.2.3.1.1.2.5.1.2 "><p id="dataartsstudio_02_0092__en-us_topic_0181281337_en-us_topic_0093082049_p6820998181358">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.01%" headers="mcps1.3.2.3.1.1.2.5.1.3 "><p id="dataartsstudio_02_0092__en-us_topic_0181281337_en-us_topic_0093082049_p15629937181358">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.03%" headers="mcps1.3.2.3.1.1.2.5.1.4 "><p id="dataartsstudio_02_0092__en-us_topic_0181281337_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_0092__en-us_topic_0181281337_row1571719661414"><td class="cellrowborder" valign="top" width="19.919999999999998%" headers="mcps1.3.2.3.1.1.2.5.1.1 "><p id="dataartsstudio_02_0092__en-us_topic_0181281337_p471876151414">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.04%" headers="mcps1.3.2.3.1.1.2.5.1.2 "><p id="dataartsstudio_02_0092__en-us_topic_0181281337_p19718146161420">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.01%" headers="mcps1.3.2.3.1.1.2.5.1.3 "><p id="dataartsstudio_02_0092__en-us_topic_0181281337_p9718196161417">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.03%" headers="mcps1.3.2.3.1.1.2.5.1.4 "><p id="dataartsstudio_02_0092__en-us_topic_0181281337_p2571117161416">Job name.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="dataartsstudio_02_0092__en-us_topic_0181281337_section10789431145710"><h4 class="sectiontitle">Request</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dataartsstudio_02_0092__en-us_topic_0181281337_table25071810112414" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameter</caption><thead align="left"><tr id="dataartsstudio_02_0092__en-us_topic_0181281337_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_0092__en-us_topic_0181281337_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_0092__en-us_topic_0181281337_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_0092__en-us_topic_0181281337_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_0092__en-us_topic_0181281337_en-us_topic_0181281363_p11149331122017">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dataartsstudio_02_0092__en-us_topic_0181281337_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_0092__en-us_topic_0181281337_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_0092__en-us_topic_0181281337_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_0092__en-us_topic_0181281337_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_0092__en-us_topic_0181281337_en-us_topic_0181281363_p169341251122511">Workspace ID.</p>
|
|
<ul id="dataartsstudio_02_0092__en-us_topic_0181281337_en-us_topic_0181281363_ul776685742514"><li id="dataartsstudio_02_0092__en-us_topic_0181281337_en-us_topic_0181281363_li076655782516">If this parameter is not set, data in the <strong id="dataartsstudio_02_0092__b13153144719461">default</strong> workspace is queried by default.</li><li id="dataartsstudio_02_0092__en-us_topic_0181281337_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_0092__en-us_topic_0181281337_table544435255017" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Parameter</caption><thead align="left"><tr id="dataartsstudio_02_0092__en-us_topic_0181281337_row444510523506"><th align="left" class="cellrowborder" valign="top" width="21.26%" id="mcps1.3.3.3.2.5.1.1"><p id="dataartsstudio_02_0092__en-us_topic_0181281337_p114461752155014">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="10.81%" id="mcps1.3.3.3.2.5.1.2"><p id="dataartsstudio_02_0092__en-us_topic_0181281337_p344615216509">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16.89%" id="mcps1.3.3.3.2.5.1.3"><p id="dataartsstudio_02_0092__en-us_topic_0181281337_p14446165285019">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="51.04%" id="mcps1.3.3.3.2.5.1.4"><p id="dataartsstudio_02_0092__en-us_topic_0181281337_p17446105245018">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dataartsstudio_02_0092__en-us_topic_0181281337_row54463527502"><td class="cellrowborder" valign="top" width="21.26%" headers="mcps1.3.3.3.2.5.1.1 "><p id="dataartsstudio_02_0092__en-us_topic_0181281337_p174468521509">jobParams</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.81%" headers="mcps1.3.3.3.2.5.1.2 "><p id="dataartsstudio_02_0092__en-us_topic_0181281337_p1844785205010">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.89%" headers="mcps1.3.3.3.2.5.1.3 "><p id="dataartsstudio_02_0092__en-us_topic_0181281337_p11447105213507">List<JobParam></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.04%" headers="mcps1.3.3.3.2.5.1.4 "><p id="dataartsstudio_02_0092__en-us_topic_0181281337_p16449152125010">Parameter for starting the job.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dataartsstudio_02_0092__en-us_topic_0181281337_table66751121393" frame="border" border="1" rules="all"><caption><b>Table 4 </b>JobParam data structure description</caption><thead align="left"><tr id="dataartsstudio_02_0092__en-us_topic_0181281337_row1567514123396"><th align="left" class="cellrowborder" valign="top" width="21.14%" id="mcps1.3.3.4.2.5.1.1"><p id="dataartsstudio_02_0092__en-us_topic_0181281337_p10675201233918">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="10.94%" id="mcps1.3.3.4.2.5.1.2"><p id="dataartsstudio_02_0092__en-us_topic_0181281337_p11675181223918">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17.130000000000003%" id="mcps1.3.3.4.2.5.1.3"><p id="dataartsstudio_02_0092__en-us_topic_0181281337_p136751712173915">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50.79%" id="mcps1.3.3.4.2.5.1.4"><p id="dataartsstudio_02_0092__en-us_topic_0181281337_p146751812123915">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dataartsstudio_02_0092__en-us_topic_0181281337_row10676912123916"><td class="cellrowborder" valign="top" width="21.14%" headers="mcps1.3.3.4.2.5.1.1 "><p id="dataartsstudio_02_0092__en-us_topic_0181281337_p367671220395">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.94%" headers="mcps1.3.3.4.2.5.1.2 "><p id="dataartsstudio_02_0092__en-us_topic_0181281337_p56764122393">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.130000000000003%" headers="mcps1.3.3.4.2.5.1.3 "><p id="dataartsstudio_02_0092__en-us_topic_0181281337_p46762124397">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50.79%" headers="mcps1.3.3.4.2.5.1.4 "><p id="dataartsstudio_02_0092__en-us_topic_0181281337_p567681217395">Name of the parameter. It cannot exceed 64 characters.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dataartsstudio_02_0092__en-us_topic_0181281337_row65381819403"><td class="cellrowborder" valign="top" width="21.14%" headers="mcps1.3.3.4.2.5.1.1 "><p id="dataartsstudio_02_0092__en-us_topic_0181281337_p14539819404">value</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.94%" headers="mcps1.3.3.4.2.5.1.2 "><p id="dataartsstudio_02_0092__en-us_topic_0181281337_p155393114011">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.130000000000003%" headers="mcps1.3.3.4.2.5.1.3 "><p id="dataartsstudio_02_0092__en-us_topic_0181281337_p11539316409">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50.79%" headers="mcps1.3.3.4.2.5.1.4 "><p id="dataartsstudio_02_0092__en-us_topic_0181281337_p1753912115406">Value of the parameter. It cannot exceed 1024 characters.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="dataartsstudio_02_0092__en-us_topic_0181281337_section17656611145018"><h4 class="sectiontitle">Response</h4><p id="dataartsstudio_02_0092__en-us_topic_0181281337_p0790948194713">None.</p>
|
|
</div>
|
|
<div class="section" id="dataartsstudio_02_0092__en-us_topic_0181281337_section358155716277"><h4 class="sectiontitle">Example</h4><p id="dataartsstudio_02_0092__en-us_topic_0181281337_p5806133873213">Start job <strong id="dataartsstudio_02_0092__en-us_topic_0181281337_b9591640464">myJob</strong>.</p>
|
|
<ul id="dataartsstudio_02_0092__en-us_topic_0181281337_ul19401245123215"><li id="dataartsstudio_02_0092__en-us_topic_0181281337_li1540115456322">Request<pre class="screen" id="dataartsstudio_02_0092__en-us_topic_0181281337_screen19433710217">POST /v1/b384b9e9ab9b4ee8994c8633aabc9505/jobs/myJob/start</pre>
|
|
</li></ul>
|
|
<ul id="dataartsstudio_02_0092__en-us_topic_0181281337_ul1593065043218"><li id="dataartsstudio_02_0092__en-us_topic_0181281337_li093015019327">Success response<p id="dataartsstudio_02_0092__en-us_topic_0181281337_p2186131670"><a name="dataartsstudio_02_0092__en-us_topic_0181281337_li093015019327"></a><a name="en-us_topic_0181281337_li093015019327"></a>HTTP status code 204</p>
|
|
</li><li id="dataartsstudio_02_0092__en-us_topic_0181281337_li313082312504">Failure response<p id="dataartsstudio_02_0092__en-us_topic_0181281337_p17868101111567"><a name="dataartsstudio_02_0092__en-us_topic_0181281337_li313082312504"></a><a name="en-us_topic_0181281337_li313082312504"></a>HTTP status code 400</p>
|
|
<pre class="screen" id="dataartsstudio_02_0092__en-us_topic_0181281337_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>
|
|
|