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>
243 lines
27 KiB
HTML
243 lines
27 KiB
HTML
<a name="dataartsstudio_02_0097"></a><a name="dataartsstudio_02_0097"></a>
|
|
|
|
<h1 class="topictitle1">Creating a Script</h1>
|
|
<div id="body0000001104334924"><div class="section" id="dataartsstudio_02_0097__en-us_topic_0181281288_section1738101810182"><h4 class="sectiontitle">Function</h4><p id="dataartsstudio_02_0097__p19906052102115">This API is used to create a script. Currently, the following script types are supported: DLI SQL, Flink SQL, RDS SQL, Spark SQL, Hive SQL, DWS SQL, Shell, Presto SQL, ClickHouse SQL, HetuEngine SQL, Python, Spark Python, and Impala SQL.</p>
|
|
</div>
|
|
<div class="section" id="dataartsstudio_02_0097__en-us_topic_0181281288_section7934966101819"><h4 class="sectiontitle">URI</h4><ul id="dataartsstudio_02_0097__en-us_topic_0181281288_ul145591424184717"><li id="dataartsstudio_02_0097__en-us_topic_0181281288_li356152404715">URI format<p id="dataartsstudio_02_0097__en-us_topic_0181281288_p076674419427"><a name="dataartsstudio_02_0097__en-us_topic_0181281288_li356152404715"></a><a name="en-us_topic_0181281288_li356152404715"></a>POST /v1/{project_id}/scripts</p>
|
|
</li></ul>
|
|
</div>
|
|
<ul id="dataartsstudio_02_0097__en-us_topic_0181281288_ul1370917277482"><li id="dataartsstudio_02_0097__en-us_topic_0181281288_li170972720484">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dataartsstudio_02_0097__en-us_topic_0181281288_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_0097__en-us_topic_0181281288_en-us_topic_0093082049_row26974916181358"><th align="left" class="cellrowborder" valign="top" width="20.05%" id="mcps1.3.3.1.1.2.5.1.1"><p id="dataartsstudio_02_0097__en-us_topic_0181281288_en-us_topic_0093082049_p37484572181358">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="10.530000000000001%" id="mcps1.3.3.1.1.2.5.1.2"><p id="dataartsstudio_02_0097__en-us_topic_0181281288_en-us_topic_0093082049_p16351468181358">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16.12%" id="mcps1.3.3.1.1.2.5.1.3"><p id="dataartsstudio_02_0097__en-us_topic_0181281288_en-us_topic_0093082049_p49400541181358">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="53.300000000000004%" id="mcps1.3.3.1.1.2.5.1.4"><p id="dataartsstudio_02_0097__en-us_topic_0181281288_en-us_topic_0093082049_p42020886181358">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dataartsstudio_02_0097__en-us_topic_0181281288_en-us_topic_0093082049_row48248640181358"><td class="cellrowborder" valign="top" width="20.05%" headers="mcps1.3.3.1.1.2.5.1.1 "><p id="dataartsstudio_02_0097__en-us_topic_0181281288_en-us_topic_0093082049_p15825795181358">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.530000000000001%" headers="mcps1.3.3.1.1.2.5.1.2 "><p id="dataartsstudio_02_0097__en-us_topic_0181281288_en-us_topic_0093082049_p6820998181358">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.12%" headers="mcps1.3.3.1.1.2.5.1.3 "><p id="dataartsstudio_02_0097__en-us_topic_0181281288_en-us_topic_0093082049_p15629937181358">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.300000000000004%" headers="mcps1.3.3.1.1.2.5.1.4 "><p id="dataartsstudio_02_0097__en-us_topic_0181281288_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 class="section" id="dataartsstudio_02_0097__en-us_topic_0181281288_section10789431145710"><h4 class="sectiontitle">Request Parameters</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dataartsstudio_02_0097__en-us_topic_0181281288_table25071810112414" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameter</caption><thead align="left"><tr id="dataartsstudio_02_0097__en-us_topic_0181281288_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_0097__en-us_topic_0181281288_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_0097__en-us_topic_0181281288_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_0097__en-us_topic_0181281288_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_0097__en-us_topic_0181281288_en-us_topic_0181281363_p11149331122017">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dataartsstudio_02_0097__en-us_topic_0181281288_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_0097__en-us_topic_0181281288_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_0097__en-us_topic_0181281288_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_0097__en-us_topic_0181281288_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_0097__en-us_topic_0181281288_en-us_topic_0181281363_p169341251122511">Workspace ID.</p>
|
|
<ul id="dataartsstudio_02_0097__en-us_topic_0181281288_en-us_topic_0181281363_ul776685742514"><li id="dataartsstudio_02_0097__en-us_topic_0181281288_en-us_topic_0181281363_li076655782516">If this parameter is not set, data in the <strong id="dataartsstudio_02_0097__b20672171819482">default</strong> workspace is queried by default.</li><li id="dataartsstudio_02_0097__en-us_topic_0181281288_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_0097__en-us_topic_0181281288_table19750184493418" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Script parameters</caption><thead align="left"><tr id="dataartsstudio_02_0097__en-us_topic_0181281288_row1475134418345"><th align="left" class="cellrowborder" valign="top" width="21.84%" id="mcps1.3.4.3.2.5.1.1"><p id="dataartsstudio_02_0097__en-us_topic_0181281288_p1275244423417">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="9.74%" id="mcps1.3.4.3.2.5.1.2"><p id="dataartsstudio_02_0097__en-us_topic_0181281288_p1375504413341">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15.659999999999998%" id="mcps1.3.4.3.2.5.1.3"><p id="dataartsstudio_02_0097__en-us_topic_0181281288_p675774416349">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="52.76%" id="mcps1.3.4.3.2.5.1.4"><p id="dataartsstudio_02_0097__en-us_topic_0181281288_p475920448344">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dataartsstudio_02_0097__en-us_topic_0181281288_row1760344113410"><td class="cellrowborder" valign="top" width="21.84%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dataartsstudio_02_0097__en-us_topic_0181281288_p5760124443410">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="9.74%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dataartsstudio_02_0097__en-us_topic_0181281288_p476174473411">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.659999999999998%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dataartsstudio_02_0097__en-us_topic_0181281288_p6763114463415">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.76%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dataartsstudio_02_0097__en-us_topic_0181281288_p1376304411342">Script name. The name contains a maximum of 128 characters, including only letters, numbers, hyphens (-), and periods (.). The script name must be unique.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dataartsstudio_02_0097__en-us_topic_0181281288_row7763244193418"><td class="cellrowborder" valign="top" width="21.84%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dataartsstudio_02_0097__en-us_topic_0181281288_p1676464463414">type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="9.74%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dataartsstudio_02_0097__en-us_topic_0181281288_p776544410349">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.659999999999998%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dataartsstudio_02_0097__en-us_topic_0181281288_p7766174423419">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.76%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dataartsstudio_02_0097__en-us_topic_0181281288_p0767244123410">Script type.</p>
|
|
<ul id="dataartsstudio_02_0097__en-us_topic_0181281288_ul1276716442349"><li id="dataartsstudio_02_0097__en-us_topic_0181281288_li20216520017">FlinkSQL</li><li id="dataartsstudio_02_0097__en-us_topic_0181281288_li676811443344">DLISQL</li><li id="dataartsstudio_02_0097__en-us_topic_0181281288_li176818449341">SparkSQL</li><li id="dataartsstudio_02_0097__en-us_topic_0181281288_li4769644143416">HiveSQL</li><li id="dataartsstudio_02_0097__en-us_topic_0181281288_li9771844153414">DWSSQL</li><li id="dataartsstudio_02_0097__en-us_topic_0181281288_li16239115616513">RDSSQL</li><li id="dataartsstudio_02_0097__en-us_topic_0181281288_li167711644103416">Shell</li><li id="dataartsstudio_02_0097__li54618256619">PRESTO</li><li id="dataartsstudio_02_0097__li935071551713">ClickHouseSQL</li><li id="dataartsstudio_02_0097__li354032511178">HetuEngineSQL</li><li id="dataartsstudio_02_0097__li631733210175">PYTHON</li><li id="dataartsstudio_02_0097__li586839101810">ImpalaSQL</li><li id="dataartsstudio_02_0097__li195654811394">Spark Python</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="dataartsstudio_02_0097__en-us_topic_0181281288_row10979193913289"><td class="cellrowborder" valign="top" width="21.84%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dataartsstudio_02_0097__en-us_topic_0181281288_p1777284413346">content</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="9.74%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dataartsstudio_02_0097__en-us_topic_0181281288_p11772184413346">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.659999999999998%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dataartsstudio_02_0097__en-us_topic_0181281288_p11773194420340">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.76%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dataartsstudio_02_0097__en-us_topic_0181281288_p7773124493414">Script content. A maximum of 4 MB is supported.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dataartsstudio_02_0097__en-us_topic_0181281288_row2416130182519"><td class="cellrowborder" valign="top" width="21.84%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dataartsstudio_02_0097__en-us_topic_0181281288_p1141615072518">directory</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="9.74%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dataartsstudio_02_0097__en-us_topic_0181281288_p1416120152512">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.659999999999998%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dataartsstudio_02_0097__en-us_topic_0181281288_p2416001259">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.76%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dataartsstudio_02_0097__en-us_topic_0181281288_p119211628765">Directory for storing the script.</p>
|
|
<p id="dataartsstudio_02_0097__en-us_topic_0181281288_p123051357125016">Access the <span id="dataartsstudio_02_0097__text222519312362">DataArts Studio</span> console and choose <strong id="dataartsstudio_02_0097__b9347850203012">Data Development</strong>. In the left navigation pane, choose <span class="menucascade" id="dataartsstudio_02_0097__menucascade134811501304"><b><span class="uicontrol" id="dataartsstudio_02_0097__uicontrol134820505300">Development</span></b> > <b><span class="uicontrol" id="dataartsstudio_02_0097__uicontrol93480506309">Develop Script</span></b></span>. In the directory tree of the script, you can view the created directories. The default directory is the <strong id="dataartsstudio_02_0097__en-us_topic_0181281288_b14556813164612">root</strong> directory.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dataartsstudio_02_0097__en-us_topic_0181281288_row97741244163419"><td class="cellrowborder" valign="top" width="21.84%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dataartsstudio_02_0097__en-us_topic_0181281288_p8774134411348">connectionName</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="9.74%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dataartsstudio_02_0097__en-us_topic_0181281288_p12775644143410">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.659999999999998%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dataartsstudio_02_0097__en-us_topic_0181281288_p187761344173415">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.76%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dataartsstudio_02_0097__en-us_topic_0181281288_p777614493418">Name of the connection associated with the script. This parameter is mandatory when <strong id="dataartsstudio_02_0097__b11417859183513">type</strong> is set to <strong id="dataartsstudio_02_0097__b1241845983511">DLISQL</strong>, <strong id="dataartsstudio_02_0097__b641845910357">SparkSQL</strong>, <strong id="dataartsstudio_02_0097__b13418115918352">HiveSQL</strong>, <strong id="dataartsstudio_02_0097__b7418175913352">DWSSQL</strong>, <strong id="dataartsstudio_02_0097__b104186597351">Shell</strong>, <strong id="dataartsstudio_02_0097__b154181759113520">PRESTO</strong>, <strong id="dataartsstudio_02_0097__b9419359153513">ClickHouseSQL</strong>, <strong id="dataartsstudio_02_0097__b1641995923513">HetuEngineSQL</strong>, <strong id="dataartsstudio_02_0097__b12419159113510">RDSSQL</strong>, <strong id="dataartsstudio_02_0097__b1141985903510">ImpalaSQL</strong>, <strong id="dataartsstudio_02_0097__b11774102493711">Spark Python</strong>, or <strong id="dataartsstudio_02_0097__b1541913597356">PYTHON</strong>. To obtain the existing connections, refer to the instructions in <a href="dataartsstudio_02_0051.html">Querying a Connection List (to Be Taken Offline)</a>. By default, this parameter is left blank.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dataartsstudio_02_0097__en-us_topic_0181281288_row47771744133413"><td class="cellrowborder" valign="top" width="21.84%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dataartsstudio_02_0097__en-us_topic_0181281288_p11779144420343">database</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="9.74%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dataartsstudio_02_0097__en-us_topic_0181281288_p677910447341">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.659999999999998%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dataartsstudio_02_0097__en-us_topic_0181281288_p6779744113415">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.76%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dataartsstudio_02_0097__en-us_topic_0181281288_p111521459151915">Database associated with an SQL statement. This parameter is available only when <strong id="dataartsstudio_02_0097__b55431957193815">type</strong> is set to <strong id="dataartsstudio_02_0097__b12543057103815">DLISQL</strong>, <strong id="dataartsstudio_02_0097__b854535714388">SparkSQL</strong>, <strong id="dataartsstudio_02_0097__b16545657153814">HiveSQL</strong>, <strong id="dataartsstudio_02_0097__b054612575383">DWSSQL</strong>, <strong id="dataartsstudio_02_0097__b254616571384">PRESTO</strong>, <strong id="dataartsstudio_02_0097__b139745312400">RDSSQL</strong>, <strong id="dataartsstudio_02_0097__b106742387402">ClickHouseSQL</strong>, <strong id="dataartsstudio_02_0097__b59514274019">ImpalaSQL</strong>, or <strong id="dataartsstudio_02_0097__b106151045144020">HetuEngineSQL</strong>.</p>
|
|
<ul id="dataartsstudio_02_0097__en-us_topic_0181281288_ul13121162217205"><li id="dataartsstudio_02_0097__en-us_topic_0181281288_li1112114221207">If <strong id="dataartsstudio_02_0097__b7359271314">type</strong> is set to <strong id="dataartsstudio_02_0097__b183616274310">DLI SQL</strong>, obtain database information by calling the API for querying all databases in the <i><cite id="dataartsstudio_02_0097__en-us_topic_0181281288_cite78218241468">Data Lake Insight API Reference</cite></i>.</li><li id="dataartsstudio_02_0097__en-us_topic_0181281288_li1773516248207">This parameter is mandatory when the script is not of any type listed.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="dataartsstudio_02_0097__en-us_topic_0181281288_row19780644113415"><td class="cellrowborder" valign="top" width="21.84%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dataartsstudio_02_0097__en-us_topic_0181281288_p12781344123416">queueName</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="9.74%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dataartsstudio_02_0097__en-us_topic_0181281288_p378154473415">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.659999999999998%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dataartsstudio_02_0097__en-us_topic_0181281288_p47824441349">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.76%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dataartsstudio_02_0097__en-us_topic_0181281288_p2783144415348">Queue name of the DLI resource. This parameter is available only when <strong id="dataartsstudio_02_0097__en-us_topic_0181281288_b292317383187">type</strong> is set to <strong id="dataartsstudio_02_0097__en-us_topic_0181281288_b129612426182">DLISQL</strong>. You can obtain the queue information by calling the API for "Querying All Queues" in the <i><cite id="dataartsstudio_02_0097__en-us_topic_0181281288_cite19650122114714">Data Lake Insight API Reference</cite></i>. By default, this parameter is left blank.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dataartsstudio_02_0097__en-us_topic_0181281288_row1684095184113"><td class="cellrowborder" valign="top" width="21.84%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dataartsstudio_02_0097__en-us_topic_0181281288_p198419513419">configuration</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="9.74%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dataartsstudio_02_0097__en-us_topic_0181281288_p284111512416">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.659999999999998%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dataartsstudio_02_0097__en-us_topic_0181281288_p1884112584116">map <String,Object></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.76%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dataartsstudio_02_0097__en-us_topic_0181281288_p59811446432">Configuration defined by a user for the job. This parameter is available only when <strong id="dataartsstudio_02_0097__en-us_topic_0181281288_b1327093892311">type</strong> is set to <strong id="dataartsstudio_02_0097__en-us_topic_0181281288_b56881143152318">DLISQL</strong>. For details about the supported configuration items, see conf parameter description in the "Submitting a SQL Job" section of the <i><cite id="dataartsstudio_02_0097__en-us_topic_0181281288_cite16113185019">Data Lake Insight API Reference</cite></i>. By default, this parameter is left blank.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dataartsstudio_02_0097__en-us_topic_0181281288_row291711515444"><td class="cellrowborder" valign="top" width="21.84%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dataartsstudio_02_0097__en-us_topic_0181281288_p12917141554414">description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="9.74%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dataartsstudio_02_0097__en-us_topic_0181281288_p2091720157442">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.659999999999998%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dataartsstudio_02_0097__en-us_topic_0181281288_p1991714152448">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.76%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dataartsstudio_02_0097__en-us_topic_0181281288_p9917161515443">The description contains a maximum of 255 characters.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dataartsstudio_02_0097__row060519251532"><td class="cellrowborder" valign="top" width="21.84%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dataartsstudio_02_0097__p176510422020">targetStatus</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="9.74%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dataartsstudio_02_0097__p127653452018">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.659999999999998%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dataartsstudio_02_0097__p1544016417209">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.76%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dataartsstudio_02_0097__p1061401192212">This parameter is required if the review function is enabled. It indicates the target status of the script. The value can be <strong id="dataartsstudio_02_0097__b131231107440">SAVED</strong>, <strong id="dataartsstudio_02_0097__b943119344416">SUBMITTED</strong>, or <strong id="dataartsstudio_02_0097__b998927134411">PRODUCTION</strong>.</p>
|
|
<ul id="dataartsstudio_02_0097__ul2799112042218"><li id="dataartsstudio_02_0097__li079910206220"><strong id="dataartsstudio_02_0097__b348574184410">SAVED</strong> indicates that the script is saved but cannot be scheduled or executed. It can be executed only after submitted and approved.</li><li id="dataartsstudio_02_0097__li32993326411"><strong id="dataartsstudio_02_0097__b3613101916453">SUBMITTED</strong> indicates that the script is automatically submitted after it is saved and can be executed after it is approved.</li><li id="dataartsstudio_02_0097__li89321940645"><strong id="dataartsstudio_02_0097__b0777918164613">PRODUCTION</strong> indicates that the script can be directly executed after it is created. Note: Only the workspace administrator can create scripts in the <strong id="dataartsstudio_02_0097__b912416464714">PRODUCTION</strong> state.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="dataartsstudio_02_0097__row425912286313"><td class="cellrowborder" valign="top" width="21.84%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dataartsstudio_02_0097__p175867202012">approvers</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="9.74%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dataartsstudio_02_0097__p97581676203">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.659999999999998%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dataartsstudio_02_0097__p77589714204">List<JobApprover></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.76%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dataartsstudio_02_0097__p1829214412218">Script approver. This parameter is required if the review function is enabled. For details, see <a href="#dataartsstudio_02_0097__table943565132314">Table 4</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="dataartsstudio_02_0097__table943565132314"></a><a name="table943565132314"></a><table cellpadding="4" cellspacing="0" summary="" id="dataartsstudio_02_0097__table943565132314" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Approver attributes</caption><thead align="left"><tr id="dataartsstudio_02_0097__row3436125112238"><th align="left" class="cellrowborder" valign="top" width="24.95750424957504%" id="mcps1.3.4.4.2.5.1.1"><p id="dataartsstudio_02_0097__p13603158182519">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="24.987501249875013%" id="mcps1.3.4.4.2.5.1.2"><p id="dataartsstudio_02_0097__p060313892519">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="24.84751524847515%" id="mcps1.3.4.4.2.5.1.3"><p id="dataartsstudio_02_0097__p186034820259">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25.207479252074794%" id="mcps1.3.4.4.2.5.1.4"><p id="dataartsstudio_02_0097__p16603158192520">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dataartsstudio_02_0097__row7436175110233"><td class="cellrowborder" valign="top" width="24.95750424957504%" headers="mcps1.3.4.4.2.5.1.1 "><p id="dataartsstudio_02_0097__p1713118288253">approverName</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="24.987501249875013%" headers="mcps1.3.4.4.2.5.1.2 "><p id="dataartsstudio_02_0097__p41311328132516">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="24.84751524847515%" headers="mcps1.3.4.4.2.5.1.3 "><p id="dataartsstudio_02_0097__p61311286252">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.207479252074794%" headers="mcps1.3.4.4.2.5.1.4 "><p id="dataartsstudio_02_0097__p413162811253">Approver name</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="dataartsstudio_02_0097__en-us_topic_0181281288_section561243517589"><h4 class="sectiontitle">Response Parameters</h4><p id="dataartsstudio_02_0097__en-us_topic_0181281288_p7541145513348">None.</p>
|
|
</div>
|
|
<div class="section" id="dataartsstudio_02_0097__en-us_topic_0181281288_section358155716277"><h4 class="sectiontitle">Example Request</h4><div class="p" id="dataartsstudio_02_0097__en-us_topic_0181281288_p1488816432455">Create a script named <strong id="dataartsstudio_02_0097__b929119245019">echoTimeShell</strong> whose type is Shell, content is <strong id="dataartsstudio_02_0097__b949953217507">echo a</strong>, and associated connection is <strong id="dataartsstudio_02_0097__b2275135325014">con</strong>.<pre class="screen" id="dataartsstudio_02_0097__en-us_topic_0181281288_screen165211354306">POST /v1/b384b9e9ab9b4ee8994c8633aabc9505/scripts
|
|
{
|
|
"name": "echoTimeShell",
|
|
"type": "Shell",
|
|
"content": "echo a",
|
|
"connectionName": "con"
|
|
}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="p" id="dataartsstudio_02_0097__p6984418114817">Create a script when the review function is enabled.<pre class="screen" id="dataartsstudio_02_0097__screen1198451817480">POST /v1/b384b9e9ab9b4ee8994c8633aabc9505/scripts
|
|
{
|
|
"name": "echoTimeShell",
|
|
"type": "Shell",
|
|
"content": "echo a",
|
|
"connectionName": "con",
|
|
"targetStatus":"SUBMITTED",
|
|
"approvers": [
|
|
{
|
|
"approverName": "userName1"
|
|
},
|
|
{
|
|
"approverName": "userName2"
|
|
}
|
|
]
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="dataartsstudio_02_0097__section633543615376"><h4 class="sectiontitle">Example Response</h4><ul id="dataartsstudio_02_0097__en-us_topic_0181281288_ul13130223205017"><li id="dataartsstudio_02_0097__en-us_topic_0181281288_li149491320463">Success response<p id="dataartsstudio_02_0097__en-us_topic_0181281288_p107513409317"><a name="dataartsstudio_02_0097__en-us_topic_0181281288_li149491320463"></a><a name="en-us_topic_0181281288_li149491320463"></a>HTTP status code 204</p>
|
|
</li><li id="dataartsstudio_02_0097__en-us_topic_0181281288_li313082312504">Failure response<p id="dataartsstudio_02_0097__en-us_topic_0181281288_p17868101111567"><a name="dataartsstudio_02_0097__en-us_topic_0181281288_li313082312504"></a><a name="en-us_topic_0181281288_li313082312504"></a>HTTP status code 400</p>
|
|
<pre class="screen" id="dataartsstudio_02_0097__en-us_topic_0181281288_screen2818105917308">{
|
|
"error_code":"DLF.6247",
|
|
"error_msg":"The script type is not specified."
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="dataartsstudio_02_0097__en-us_topic_0181281288_section1623417185013"><h4 class="sectiontitle">Status Code</h4><p id="dataartsstudio_02_0097__en-us_topic_0181281288_p285775634815">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>
|
|
|