vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/dataartsstudio/api-ref/dataartsstudio_02_0058.html
Xiong, Chen Xiao 14a6d65e8c DataArts API 20240130 version 
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>
2024-03-01 11:46:15 +00:00

149 lines
14 KiB
HTML
Raw Blame History

<a name="dataartsstudio_02_0058"></a><a name="dataartsstudio_02_0058"></a>
<h1 class="topictitle1">Executing a Script</h1>
<div id="body0000001104654658"><div class="section" id="dataartsstudio_02_0058__en-us_topic_0181281350_section1738101810182"><h4 class="sectiontitle">Function</h4><p id="dataartsstudio_02_0058__en-us_topic_0181281350_p1912913467404">This API is used to execute a specific script, which can be a DWS SQL, DLI SQL, RDS SQL, Flink SQL, Hive SQL, Presto SQL, or Spark SQL script. A script instance is generated each time the script is executed. You can call the API <a href="dataartsstudio_02_0101.html">Querying the Execution Result of a Script Instance</a> to obtain script execution results.</p>
</div>
<div class="section" id="dataartsstudio_02_0058__en-us_topic_0181281350_section7934966101819"><h4 class="sectiontitle">URI</h4><ul id="dataartsstudio_02_0058__en-us_topic_0181281350_ul145591424184717"><li id="dataartsstudio_02_0058__en-us_topic_0181281350_li356152404715">URI format<p id="dataartsstudio_02_0058__en-us_topic_0181281350_p076674419427"><a name="dataartsstudio_02_0058__en-us_topic_0181281350_li356152404715"></a><a name="en-us_topic_0181281350_li356152404715"></a>POST /v1/{project_id}/scripts/{script_name}/execute</p>
</li></ul>
</div>
<ul id="dataartsstudio_02_0058__en-us_topic_0181281350_ul1370917277482"><li id="dataartsstudio_02_0058__en-us_topic_0181281350_li170972720484">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dataartsstudio_02_0058__en-us_topic_0181281350_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_0058__en-us_topic_0181281350_en-us_topic_0093082049_row26974916181358"><th align="left" class="cellrowborder" valign="top" width="19.919999999999998%" id="mcps1.3.3.1.1.2.5.1.1"><p id="dataartsstudio_02_0058__en-us_topic_0181281350_en-us_topic_0093082049_p37484572181358">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="10.66%" id="mcps1.3.3.1.1.2.5.1.2"><p id="dataartsstudio_02_0058__en-us_topic_0181281350_en-us_topic_0093082049_p16351468181358">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.24%" id="mcps1.3.3.1.1.2.5.1.3"><p id="dataartsstudio_02_0058__en-us_topic_0181281350_en-us_topic_0093082049_p49400541181358">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53.18000000000001%" id="mcps1.3.3.1.1.2.5.1.4"><p id="dataartsstudio_02_0058__en-us_topic_0181281350_en-us_topic_0093082049_p42020886181358">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dataartsstudio_02_0058__en-us_topic_0181281350_en-us_topic_0093082049_row48248640181358"><td class="cellrowborder" valign="top" width="19.919999999999998%" headers="mcps1.3.3.1.1.2.5.1.1 "><p id="dataartsstudio_02_0058__en-us_topic_0181281350_en-us_topic_0093082049_p15825795181358">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="10.66%" headers="mcps1.3.3.1.1.2.5.1.2 "><p id="dataartsstudio_02_0058__en-us_topic_0181281350_en-us_topic_0093082049_p6820998181358">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="16.24%" headers="mcps1.3.3.1.1.2.5.1.3 "><p id="dataartsstudio_02_0058__en-us_topic_0181281350_en-us_topic_0093082049_p15629937181358">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.18000000000001%" headers="mcps1.3.3.1.1.2.5.1.4 "><p id="dataartsstudio_02_0058__en-us_topic_0181281350_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_0058__en-us_topic_0181281350_row28831818154718"><td class="cellrowborder" valign="top" width="19.919999999999998%" headers="mcps1.3.3.1.1.2.5.1.1 "><p id="dataartsstudio_02_0058__en-us_topic_0181281350_p5884111818473">script_name</p>
</td>
<td class="cellrowborder" valign="top" width="10.66%" headers="mcps1.3.3.1.1.2.5.1.2 "><p id="dataartsstudio_02_0058__en-us_topic_0181281350_p788431814474">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="16.24%" headers="mcps1.3.3.1.1.2.5.1.3 "><p id="dataartsstudio_02_0058__en-us_topic_0181281350_p188511183475">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.18000000000001%" headers="mcps1.3.3.1.1.2.5.1.4 "><p id="dataartsstudio_02_0058__en-us_topic_0181281350_p1885151864710">Script name.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<div class="section" id="dataartsstudio_02_0058__en-us_topic_0181281350_section10789431145710"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dataartsstudio_02_0058__en-us_topic_0181281350_table25071810112414" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameter</caption><thead align="left"><tr id="dataartsstudio_02_0058__en-us_topic_0181281350_en-us_topic_0181281363_row3746915131710"><th align="left" class="cellrowborder" valign="top" width="15.010000000000002%" id="mcps1.3.4.2.2.5.1.1"><p id="dataartsstudio_02_0058__en-us_topic_0181281350_en-us_topic_0181281363_p131491731112013">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.93%" id="mcps1.3.4.2.2.5.1.2"><p id="dataartsstudio_02_0058__en-us_topic_0181281350_en-us_topic_0181281363_p3149113112204">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18.73%" id="mcps1.3.4.2.2.5.1.3"><p id="dataartsstudio_02_0058__en-us_topic_0181281350_en-us_topic_0181281363_p13149173119204">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="49.33%" id="mcps1.3.4.2.2.5.1.4"><p id="dataartsstudio_02_0058__en-us_topic_0181281350_en-us_topic_0181281363_p11149331122017">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dataartsstudio_02_0058__en-us_topic_0181281350_en-us_topic_0181281363_row174620159179"><td class="cellrowborder" valign="top" width="15.010000000000002%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dataartsstudio_02_0058__en-us_topic_0181281350_en-us_topic_0181281363_p1150183116205">workspace</p>
</td>
<td class="cellrowborder" valign="top" width="16.93%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dataartsstudio_02_0058__en-us_topic_0181281350_en-us_topic_0181281363_p4150531152016">No</p>
</td>
<td class="cellrowborder" valign="top" width="18.73%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dataartsstudio_02_0058__en-us_topic_0181281350_en-us_topic_0181281363_p181505317209">String</p>
</td>
<td class="cellrowborder" valign="top" width="49.33%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dataartsstudio_02_0058__en-us_topic_0181281350_en-us_topic_0181281363_p169341251122511">Workspace ID.</p>
<ul id="dataartsstudio_02_0058__en-us_topic_0181281350_en-us_topic_0181281363_ul776685742514"><li id="dataartsstudio_02_0058__en-us_topic_0181281350_en-us_topic_0181281363_li076655782516">If this parameter is not set, data in the <strong id="dataartsstudio_02_0058__b1275184715817">default</strong> workspace is queried by default.</li><li id="dataartsstudio_02_0058__en-us_topic_0181281350_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_0058__en-us_topic_0181281350_table19750184493418" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Parameters</caption><thead align="left"><tr id="dataartsstudio_02_0058__en-us_topic_0181281350_row1475134418345"><th align="left" class="cellrowborder" valign="top" width="21.39%" id="mcps1.3.4.3.2.5.1.1"><p id="dataartsstudio_02_0058__en-us_topic_0181281350_p1275244423417">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="10.33%" id="mcps1.3.4.3.2.5.1.2"><p id="dataartsstudio_02_0058__en-us_topic_0181281350_p1375504413341">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20.9%" id="mcps1.3.4.3.2.5.1.3"><p id="dataartsstudio_02_0058__en-us_topic_0181281350_p675774416349">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="47.38%" id="mcps1.3.4.3.2.5.1.4"><p id="dataartsstudio_02_0058__en-us_topic_0181281350_p475920448344">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dataartsstudio_02_0058__en-us_topic_0181281350_row104900151689"><td class="cellrowborder" valign="top" width="21.39%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dataartsstudio_02_0058__en-us_topic_0181281350_p2049191514818">params</p>
</td>
<td class="cellrowborder" valign="top" width="10.33%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dataartsstudio_02_0058__en-us_topic_0181281350_p2491101514812">No</p>
</td>
<td class="cellrowborder" valign="top" width="20.9%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dataartsstudio_02_0058__en-us_topic_0181281350_p1049114151287">Object</p>
</td>
<td class="cellrowborder" valign="top" width="47.38%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dataartsstudio_02_0058__en-us_topic_0181281350_p174912151883">Script parameters of the Map&lt;String,String&gt; type. If a parameter is defined in the script, the parameter value is carried in the params.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="dataartsstudio_02_0058__en-us_topic_0181281350_p153664418419">Script parameters refer to the parameters in the script content, as shown in the following figure.</p>
<p id="dataartsstudio_02_0058__en-us_topic_0181281350_p980173515517"><span><img id="dataartsstudio_02_0058__en-us_topic_0181281350_image3615105812715" src="en-us_image_0000001668210950.png" width="465.5" height="51.324301000000006" title="Click to enlarge" class="imgResize"></span></p>
</div>
<div class="section" id="dataartsstudio_02_0058__en-us_topic_0181281350_section561243517589"><h4 class="sectiontitle">Response Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dataartsstudio_02_0058__en-us_topic_0181281350_table156150538710" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response parameters</caption><thead align="left"><tr id="dataartsstudio_02_0058__en-us_topic_0181281350_row16156531079"><th align="left" class="cellrowborder" valign="top" width="21.63%" id="mcps1.3.5.2.2.5.1.1"><p id="dataartsstudio_02_0058__en-us_topic_0181281350_p2615553976">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="10.209999999999999%" id="mcps1.3.5.2.2.5.1.2"><p id="dataartsstudio_02_0058__en-us_topic_0181281350_p116153531175">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15.190000000000001%" id="mcps1.3.5.2.2.5.1.3"><p id="dataartsstudio_02_0058__en-us_topic_0181281350_p96153531371">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="52.96999999999999%" id="mcps1.3.5.2.2.5.1.4"><p id="dataartsstudio_02_0058__en-us_topic_0181281350_p16157537714">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dataartsstudio_02_0058__en-us_topic_0181281350_row206153539712"><td class="cellrowborder" valign="top" width="21.63%" headers="mcps1.3.5.2.2.5.1.1 "><p id="dataartsstudio_02_0058__en-us_topic_0181281350_p86151353073">instanceId</p>
</td>
<td class="cellrowborder" valign="top" width="10.209999999999999%" headers="mcps1.3.5.2.2.5.1.2 "><p id="dataartsstudio_02_0058__en-us_topic_0181281350_p76153534719">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="15.190000000000001%" headers="mcps1.3.5.2.2.5.1.3 "><p id="dataartsstudio_02_0058__en-us_topic_0181281350_p56151653378">String</p>
</td>
<td class="cellrowborder" valign="top" width="52.96999999999999%" headers="mcps1.3.5.2.2.5.1.4 "><p id="dataartsstudio_02_0058__en-us_topic_0181281350_p1361519532710">ID of the instance that executes the script. You can obtain the execution result by using the instance ID in <a href="dataartsstudio_02_0101.html">Querying the Execution Result of a Script Instance</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="dataartsstudio_02_0058__section39388389289"><h4 class="sectiontitle">Example Request</h4><p id="dataartsstudio_02_0058__p92701320164718">Run the <strong id="dataartsstudio_02_0058__b37011410316">dws_sql</strong> script. In the script, the value of <strong id="dataartsstudio_02_0058__b1150192515318">tableVar</strong> is <strong id="dataartsstudio_02_0058__b2304133014319">citys</strong>, and the value of <strong id="dataartsstudio_02_0058__b12858143032">time</strong> is <strong id="dataartsstudio_02_0058__b23984494319">2019-07-25</strong>.</p>
<pre class="screen" id="dataartsstudio_02_0058__screen5938103812811">POST /v1/b384b9e9ab9b4ee8994c8633aabc9505/scripts/dws_sql/execute
{
"params": {
"tableVar": "citys",
"time": "2019-07-25"
}
}</pre>
</div>
<div class="section" id="dataartsstudio_02_0058__en-us_topic_0181281350_section358155716277"><h4 class="sectiontitle">Example Response</h4><ul id="dataartsstudio_02_0058__en-us_topic_0181281350_ul849401320464"><li id="dataartsstudio_02_0058__en-us_topic_0181281350_li1530714111306">Success response<p id="dataartsstudio_02_0058__en-us_topic_0181281350_p1430764112307"><a name="dataartsstudio_02_0058__en-us_topic_0181281350_li1530714111306"></a><a name="en-us_topic_0181281350_li1530714111306"></a>HTTP status code 200</p>
</li></ul>
<ul id="dataartsstudio_02_0058__en-us_topic_0181281350_ul4337895312"><li id="dataartsstudio_02_0058__en-us_topic_0181281350_li697361214553">Failure response<p id="dataartsstudio_02_0058__en-us_topic_0181281350_p89261205810"><a name="dataartsstudio_02_0058__en-us_topic_0181281350_li697361214553"></a><a name="en-us_topic_0181281350_li697361214553"></a>HTTP status code 400</p>
<pre class="screen" id="dataartsstudio_02_0058__en-us_topic_0181281350_screen681114215538">{
"error_code":"DLF.6201",
"error_msg":"The script does not exist."
}</pre>
</li></ul>
</div>
<div class="section" id="dataartsstudio_02_0058__en-us_topic_0181281350_section1353211420567"><h4 class="sectiontitle">Status Codes</h4><p id="dataartsstudio_02_0058__en-us_topic_0181281350_p143101838105620">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_0056.html">Script Development APIs</a></div>
</div>
</div>
<script language="JavaScript">
<!--
image_size('.imgResize');
var msg_imageMax = "view original image";
var msg_imageClose = "close";
//--></script>
View Git Blame Copy Permalink