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>
188 lines
16 KiB
HTML
188 lines
16 KiB
HTML
<a name="dataartsstudio_02_0091"></a><a name="dataartsstudio_02_0091"></a>
|
|
|
|
<h1 class="topictitle1">Executing a Job Immediately</h1>
|
|
<div id="body0000001104814546"><div class="section" id="dataartsstudio_02_0091__en-us_topic_0181281286_section1738101810182"><h4 class="sectiontitle">Function</h4><p id="dataartsstudio_02_0091__en-us_topic_0181281286_p1912913467404">This API is used to execute a job immediately and check whether the job can be executed successfully.</p>
|
|
</div>
|
|
<div class="section" id="dataartsstudio_02_0091__en-us_topic_0181281286_section7934966101819"><h4 class="sectiontitle">URI</h4><ul id="dataartsstudio_02_0091__en-us_topic_0181281286_ul145591424184717"><li id="dataartsstudio_02_0091__en-us_topic_0181281286_li356152404715">URI format<p id="dataartsstudio_02_0091__en-us_topic_0181281286_p076674419427"><a name="dataartsstudio_02_0091__en-us_topic_0181281286_li356152404715"></a><a name="en-us_topic_0181281286_li356152404715"></a>POST /v1/{project_id}/jobs/{job_name}/run-immediate</p>
|
|
</li></ul>
|
|
<ul id="dataartsstudio_02_0091__en-us_topic_0181281286_ul1370917277482"><li id="dataartsstudio_02_0091__en-us_topic_0181281286_li170972720484">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dataartsstudio_02_0091__en-us_topic_0181281286_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_0091__en-us_topic_0181281286_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_0091__en-us_topic_0181281286_en-us_topic_0093082049_p37484572181358">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="10.79%" id="mcps1.3.2.3.1.1.2.5.1.2"><p id="dataartsstudio_02_0091__en-us_topic_0181281286_en-us_topic_0093082049_p16351468181358">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15.989999999999998%" id="mcps1.3.2.3.1.1.2.5.1.3"><p id="dataartsstudio_02_0091__en-us_topic_0181281286_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_0091__en-us_topic_0181281286_en-us_topic_0093082049_p42020886181358">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dataartsstudio_02_0091__en-us_topic_0181281286_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_0091__en-us_topic_0181281286_en-us_topic_0093082049_p15825795181358">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.79%" headers="mcps1.3.2.3.1.1.2.5.1.2 "><p id="dataartsstudio_02_0091__en-us_topic_0181281286_en-us_topic_0093082049_p6820998181358">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.989999999999998%" headers="mcps1.3.2.3.1.1.2.5.1.3 "><p id="dataartsstudio_02_0091__en-us_topic_0181281286_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_0091__en-us_topic_0181281286_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_0091__en-us_topic_0181281286_row1571719661414"><td class="cellrowborder" valign="top" width="19.919999999999998%" headers="mcps1.3.2.3.1.1.2.5.1.1 "><p id="dataartsstudio_02_0091__en-us_topic_0181281286_p471876151414">job_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.79%" headers="mcps1.3.2.3.1.1.2.5.1.2 "><p id="dataartsstudio_02_0091__en-us_topic_0181281286_p19718146161420">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.989999999999998%" headers="mcps1.3.2.3.1.1.2.5.1.3 "><p id="dataartsstudio_02_0091__en-us_topic_0181281286_p9718196161417">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_0091__en-us_topic_0181281286_p2571117161416">Job name.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="dataartsstudio_02_0091__en-us_topic_0181281286_section10789431145710"><h4 class="sectiontitle">Request Parameters</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dataartsstudio_02_0091__en-us_topic_0181281286_table25071810112414" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameter</caption><thead align="left"><tr id="dataartsstudio_02_0091__en-us_topic_0181281286_en-us_topic_0181281363_row3746915131710"><th align="left" class="cellrowborder" valign="top" width="20.73%" id="mcps1.3.3.2.2.5.1.1"><p id="dataartsstudio_02_0091__en-us_topic_0181281286_en-us_topic_0181281363_p131491731112013">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="11.21%" id="mcps1.3.3.2.2.5.1.2"><p id="dataartsstudio_02_0091__en-us_topic_0181281286_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_0091__en-us_topic_0181281286_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_0091__en-us_topic_0181281286_en-us_topic_0181281363_p11149331122017">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dataartsstudio_02_0091__en-us_topic_0181281286_en-us_topic_0181281363_row174620159179"><td class="cellrowborder" valign="top" width="20.73%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dataartsstudio_02_0091__en-us_topic_0181281286_en-us_topic_0181281363_p1150183116205">workspace</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.21%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dataartsstudio_02_0091__en-us_topic_0181281286_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_0091__en-us_topic_0181281286_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_0091__en-us_topic_0181281286_en-us_topic_0181281363_p169341251122511">Workspace ID.</p>
|
|
<ul id="dataartsstudio_02_0091__en-us_topic_0181281286_en-us_topic_0181281363_ul776685742514"><li id="dataartsstudio_02_0091__en-us_topic_0181281286_en-us_topic_0181281363_li076655782516">If this parameter is not set, data in the <strong id="dataartsstudio_02_0091__b681414194614">default</strong> workspace is queried by default.</li><li id="dataartsstudio_02_0091__en-us_topic_0181281286_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_0091__en-us_topic_0181281286_table544435255017" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Parameter</caption><thead align="left"><tr id="dataartsstudio_02_0091__en-us_topic_0181281286_row444510523506"><th align="left" class="cellrowborder" valign="top" width="20.93%" id="mcps1.3.3.3.2.5.1.1"><p id="dataartsstudio_02_0091__en-us_topic_0181281286_p114461752155014">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="11.08%" id="mcps1.3.3.3.2.5.1.2"><p id="dataartsstudio_02_0091__en-us_topic_0181281286_p344615216509">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18.58%" id="mcps1.3.3.3.2.5.1.3"><p id="dataartsstudio_02_0091__en-us_topic_0181281286_p14446165285019">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="49.41%" id="mcps1.3.3.3.2.5.1.4"><p id="dataartsstudio_02_0091__en-us_topic_0181281286_p17446105245018">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dataartsstudio_02_0091__en-us_topic_0181281286_row54463527502"><td class="cellrowborder" valign="top" width="20.93%" headers="mcps1.3.3.3.2.5.1.1 "><p id="dataartsstudio_02_0091__en-us_topic_0181281286_p174468521509">jobParams</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.08%" headers="mcps1.3.3.3.2.5.1.2 "><p id="dataartsstudio_02_0091__en-us_topic_0181281286_p1844785205010">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.58%" headers="mcps1.3.3.3.2.5.1.3 "><p id="dataartsstudio_02_0091__en-us_topic_0181281286_p11447105213507">List<JobParam></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.41%" headers="mcps1.3.3.3.2.5.1.4 "><p id="dataartsstudio_02_0091__en-us_topic_0181281286_p16449152125010">Parameters for executing a job immediately</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dataartsstudio_02_0091__en-us_topic_0181281286_table66751121393" frame="border" border="1" rules="all"><caption><b>Table 4 </b>JobParam data structure description</caption><thead align="left"><tr id="dataartsstudio_02_0091__en-us_topic_0181281286_row1567514123396"><th align="left" class="cellrowborder" valign="top" width="20.93%" id="mcps1.3.3.4.2.5.1.1"><p id="dataartsstudio_02_0091__en-us_topic_0181281286_p10675201233918">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="11.25%" id="mcps1.3.3.4.2.5.1.2"><p id="dataartsstudio_02_0091__en-us_topic_0181281286_p11675181223918">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18.22%" id="mcps1.3.3.4.2.5.1.3"><p id="dataartsstudio_02_0091__en-us_topic_0181281286_p136751712173915">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="49.6%" id="mcps1.3.3.4.2.5.1.4"><p id="dataartsstudio_02_0091__en-us_topic_0181281286_p146751812123915">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dataartsstudio_02_0091__en-us_topic_0181281286_row10676912123916"><td class="cellrowborder" valign="top" width="20.93%" headers="mcps1.3.3.4.2.5.1.1 "><p id="dataartsstudio_02_0091__en-us_topic_0181281286_p367671220395">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.25%" headers="mcps1.3.3.4.2.5.1.2 "><p id="dataartsstudio_02_0091__en-us_topic_0181281286_p56764122393">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.22%" headers="mcps1.3.3.4.2.5.1.3 "><p id="dataartsstudio_02_0091__en-us_topic_0181281286_p46762124397">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.6%" headers="mcps1.3.3.4.2.5.1.4 "><p id="dataartsstudio_02_0091__en-us_topic_0181281286_p567681217395">Name of the parameter. It cannot exceed 64 characters.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dataartsstudio_02_0091__en-us_topic_0181281286_row65381819403"><td class="cellrowborder" valign="top" width="20.93%" headers="mcps1.3.3.4.2.5.1.1 "><p id="dataartsstudio_02_0091__en-us_topic_0181281286_p14539819404">value</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.25%" headers="mcps1.3.3.4.2.5.1.2 "><p id="dataartsstudio_02_0091__en-us_topic_0181281286_p155393114011">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.22%" headers="mcps1.3.3.4.2.5.1.3 "><p id="dataartsstudio_02_0091__en-us_topic_0181281286_p11539316409">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.6%" headers="mcps1.3.3.4.2.5.1.4 "><p id="dataartsstudio_02_0091__en-us_topic_0181281286_p1753912115406">Value of the parameter. It cannot exceed 1,024 characters.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dataartsstudio_02_0091__row39092803115"><td class="cellrowborder" valign="top" width="20.93%" headers="mcps1.3.3.4.2.5.1.1 "><p id="dataartsstudio_02_0091__p634662891111">paramType</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.25%" headers="mcps1.3.3.4.2.5.1.2 "><p id="dataartsstudio_02_0091__p41441279118">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.22%" headers="mcps1.3.3.4.2.5.1.3 "><p id="dataartsstudio_02_0091__p1714418715114">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.6%" headers="mcps1.3.3.4.2.5.1.4 "><p id="dataartsstudio_02_0091__p314417181114">Parameter type</p>
|
|
<ul id="dataartsstudio_02_0091__ul16456430192810"><li id="dataartsstudio_02_0091__li04567306283">variable</li><li id="dataartsstudio_02_0091__li3457330162811">constants</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="dataartsstudio_02_0091__en-us_topic_0181281286_section17656611145018"><h4 class="sectiontitle">Response Parameters</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dataartsstudio_02_0091__en-us_topic_0181281286_table19656151112506" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Response parameter</caption><thead align="left"><tr id="dataartsstudio_02_0091__en-us_topic_0181281286_row1965718115501"><th align="left" class="cellrowborder" valign="top" width="21.63%" id="mcps1.3.4.2.2.5.1.1"><p id="dataartsstudio_02_0091__en-us_topic_0181281286_p17659111205011">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="10.81%" id="mcps1.3.4.2.2.5.1.2"><p id="dataartsstudio_02_0091__en-us_topic_0181281286_p565991111500">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="14.95%" id="mcps1.3.4.2.2.5.1.3"><p id="dataartsstudio_02_0091__en-us_topic_0181281286_p565913119501">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_0091__en-us_topic_0181281286_p865911125012">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dataartsstudio_02_0091__en-us_topic_0181281286_row18287105520520"><td class="cellrowborder" valign="top" width="21.63%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dataartsstudio_02_0091__en-us_topic_0181281286_p580013074318">instanceId</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.81%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dataartsstudio_02_0091__en-us_topic_0181281286_p1180210134320">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.95%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dataartsstudio_02_0091__en-us_topic_0181281286_p280460204318">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.61%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dataartsstudio_02_0091__en-us_topic_0181281286_p208081302437">Job instance ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="dataartsstudio_02_0091__en-us_topic_0181281286_section358155716277"><h4 class="sectiontitle">Example Request</h4><div class="p" id="dataartsstudio_02_0091__en-us_topic_0181281286_p5806133873213">Execute the <strong id="dataartsstudio_02_0091__en-us_topic_0181281286_b14791916409">myJob</strong> job once. The job contains parameter <strong id="dataartsstudio_02_0091__b1468511071113">aaa</strong> with value <strong id="dataartsstudio_02_0091__b186455113">111</strong> and parameter <strong id="dataartsstudio_02_0091__b21471218116">bbb</strong> with value <strong id="dataartsstudio_02_0091__b441511831113">222</strong>.<pre class="screen" id="dataartsstudio_02_0091__en-us_topic_0181281286_screen19433710217">POST /v1/b384b9e9ab9b4ee8994c8633aabc9505/jobs/myJob/run-immediate
|
|
{
|
|
"jobParams":[
|
|
{
|
|
"name":"aaa",
|
|
"value":"111"
|
|
},
|
|
{
|
|
"name":"bbb",
|
|
"value":"222"
|
|
}
|
|
]
|
|
}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="dataartsstudio_02_0091__section1996002355511"><h4 class="sectiontitle">Example Response</h4><ul id="dataartsstudio_02_0091__ul18960172314554"><li id="dataartsstudio_02_0091__li4960142314551">Success response<pre class="screen" id="dataartsstudio_02_0091__screen8960132365519">{
|
|
"instanceId":132343
|
|
}</pre>
|
|
</li><li id="dataartsstudio_02_0091__li11960182315513">Failure response<p id="dataartsstudio_02_0091__p4960223205519"><a name="dataartsstudio_02_0091__li11960182315513"></a><a name="li11960182315513"></a>HTTP status code 400</p>
|
|
<pre class="screen" id="dataartsstudio_02_0091__screen199601323175511">{
|
|
"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>
|
|
|