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>
152 lines
14 KiB
HTML
152 lines
14 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/{job_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="projectid_accountid.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">job_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 Parameters</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__table2033514251972" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Parameters</caption><thead align="left"><tr id="dataartsstudio_02_0092__row1033515252720"><th align="left" class="cellrowborder" valign="top" width="15.15%" id="mcps1.3.3.3.2.5.1.1"><p id="dataartsstudio_02_0092__p173351925379">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17.59%" id="mcps1.3.3.3.2.5.1.2"><p id="dataartsstudio_02_0092__p12041467175">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17.990000000000002%" id="mcps1.3.3.3.2.5.1.3"><p id="dataartsstudio_02_0092__p1133514251079">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="49.27%" id="mcps1.3.3.3.2.5.1.4"><p id="dataartsstudio_02_0092__p17336122513719">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dataartsstudio_02_0092__row533614251077"><td class="cellrowborder" valign="top" width="15.15%" headers="mcps1.3.3.3.2.5.1.1 "><p id="dataartsstudio_02_0092__p133642515715">jobParams</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.59%" headers="mcps1.3.3.3.2.5.1.2 "><p id="dataartsstudio_02_0092__p1020494651719">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.990000000000002%" headers="mcps1.3.3.3.2.5.1.3 "><p id="dataartsstudio_02_0092__p7336825679">List<JobParam></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.27%" headers="mcps1.3.3.3.2.5.1.4 "><p id="dataartsstudio_02_0092__p1133615255713">Parameter for starting the job</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dataartsstudio_02_0092__en-us_topic_0181281374_table5837184718449" 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_0181281374_row9844174718440"><th align="left" class="cellrowborder" valign="top" width="15.229999999999999%" id="mcps1.3.4.2.5.1.1"><p id="dataartsstudio_02_0092__en-us_topic_0181281374_p148465471447">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17.59%" id="mcps1.3.4.2.5.1.2"><p id="dataartsstudio_02_0092__en-us_topic_0181281374_p1484934764410">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18.3%" id="mcps1.3.4.2.5.1.3"><p id="dataartsstudio_02_0092__en-us_topic_0181281374_p11852104774415">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="48.88%" id="mcps1.3.4.2.5.1.4"><p id="dataartsstudio_02_0092__en-us_topic_0181281374_p985684704417">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dataartsstudio_02_0092__en-us_topic_0181281374_row7857647104419"><td class="cellrowborder" valign="top" width="15.229999999999999%" headers="mcps1.3.4.2.5.1.1 "><p id="dataartsstudio_02_0092__p1434592815112">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.59%" headers="mcps1.3.4.2.5.1.2 "><p id="dataartsstudio_02_0092__en-us_topic_0181281374_p1886244718449">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.3%" headers="mcps1.3.4.2.5.1.3 "><p id="dataartsstudio_02_0092__p1214332017125">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.88%" headers="mcps1.3.4.2.5.1.4 "><p id="dataartsstudio_02_0092__en-us_topic_0181281286_p567681217395">Name of the parameter. It cannot exceed 64 characters.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dataartsstudio_02_0092__en-us_topic_0181281374_row10867154744419"><td class="cellrowborder" valign="top" width="15.229999999999999%" headers="mcps1.3.4.2.5.1.1 "><p id="dataartsstudio_02_0092__p173469285118">value</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.59%" headers="mcps1.3.4.2.5.1.2 "><p id="dataartsstudio_02_0092__en-us_topic_0181281374_p29251413215">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.3%" headers="mcps1.3.4.2.5.1.3 "><p id="dataartsstudio_02_0092__p81481120131218">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.88%" headers="mcps1.3.4.2.5.1.4 "><p id="dataartsstudio_02_0092__en-us_topic_0181281286_p1753912115406">Value of the parameter. It cannot exceed 1,024 characters.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dataartsstudio_02_0092__row121441471119"><td class="cellrowborder" valign="top" width="15.229999999999999%" headers="mcps1.3.4.2.5.1.1 "><p id="dataartsstudio_02_0092__p634662891111">paramType</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.59%" headers="mcps1.3.4.2.5.1.2 "><p id="dataartsstudio_02_0092__p41441279118">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.3%" headers="mcps1.3.4.2.5.1.3 "><p id="dataartsstudio_02_0092__p1714418715114">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.88%" headers="mcps1.3.4.2.5.1.4 "><p id="dataartsstudio_02_0092__p314417181114">Parameter type</p>
|
|
<ul id="dataartsstudio_02_0092__ul16456430192810"><li id="dataartsstudio_02_0092__li04567306283">variable</li><li id="dataartsstudio_02_0092__li3457330162811">constants</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div class="section" id="dataartsstudio_02_0092__en-us_topic_0181281337_section17656611145018"><h4 class="sectiontitle">Response Parameters</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 Request</h4><div class="p" id="dataartsstudio_02_0092__en-us_topic_0181281337_p5806133873213">Start job <strong id="dataartsstudio_02_0092__en-us_topic_0181281337_b9591640464">myJob</strong>.<pre class="screen" id="dataartsstudio_02_0092__en-us_topic_0181281337_screen19433710217">POST /v1/b384b9e9ab9b4ee8994c8633aabc9505/jobs/myJob/start</pre>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="dataartsstudio_02_0092__section144711754134018"><h4 class="sectiontitle">Example Response</h4><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_0062.html">Job Development APIs</a></div>
|
|
</div>
|
|
</div>
|
|
|