vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/dataartsstudio/api-ref/dataartsstudio_02_0098.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

240 lines
28 KiB
HTML
Raw Blame History

<a name="dataartsstudio_02_0098"></a><a name="dataartsstudio_02_0098"></a>
<h1 class="topictitle1">Modifying a Script</h1>
<div id="body0000001104654696"><div class="section" id="dataartsstudio_02_0098__en-us_topic_0181629373_section1738101810182"><h4 class="sectiontitle">Function</h4><p id="dataartsstudio_02_0098__en-us_topic_0181629373_p1912913467404">This API is used to modify the configuration items or script contents of a script.</p>
<ul id="dataartsstudio_02_0098__en-us_topic_0181629373_ul613417135116"><li id="dataartsstudio_02_0098__en-us_topic_0181629373_li1513407125119">When modifying a script, specify the name of the script to be modified.</li><li id="dataartsstudio_02_0098__en-us_topic_0181629373_li6874480517">The script name and type cannot be modified.</li></ul>
</div>
<div class="section" id="dataartsstudio_02_0098__en-us_topic_0181629373_section7934966101819"><h4 class="sectiontitle">URI</h4><ul id="dataartsstudio_02_0098__en-us_topic_0181629373_ul145591424184717"><li id="dataartsstudio_02_0098__en-us_topic_0181629373_li356152404715">URI format<p id="dataartsstudio_02_0098__en-us_topic_0181629373_p076674419427"><a name="dataartsstudio_02_0098__en-us_topic_0181629373_li356152404715"></a><a name="en-us_topic_0181629373_li356152404715"></a>PUT /v1/{project_id}/scripts/{script_name}</p>
</li></ul>
</div>
<ul id="dataartsstudio_02_0098__en-us_topic_0181629373_ul1370917277482"><li id="dataartsstudio_02_0098__en-us_topic_0181629373_li170972720484">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dataartsstudio_02_0098__en-us_topic_0181629373_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_0098__en-us_topic_0181629373_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_0098__en-us_topic_0181629373_en-us_topic_0093082049_p37484572181358">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="10.41%" id="mcps1.3.3.1.1.2.5.1.2"><p id="dataartsstudio_02_0098__en-us_topic_0181629373_en-us_topic_0093082049_p16351468181358">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15.86%" id="mcps1.3.3.1.1.2.5.1.3"><p id="dataartsstudio_02_0098__en-us_topic_0181629373_en-us_topic_0093082049_p49400541181358">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53.68000000000001%" id="mcps1.3.3.1.1.2.5.1.4"><p id="dataartsstudio_02_0098__en-us_topic_0181629373_en-us_topic_0093082049_p42020886181358">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dataartsstudio_02_0098__en-us_topic_0181629373_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_0098__en-us_topic_0181629373_en-us_topic_0093082049_p15825795181358">projectId</p>
</td>
<td class="cellrowborder" valign="top" width="10.41%" headers="mcps1.3.3.1.1.2.5.1.2 "><p id="dataartsstudio_02_0098__en-us_topic_0181629373_en-us_topic_0093082049_p6820998181358">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="15.86%" headers="mcps1.3.3.1.1.2.5.1.3 "><p id="dataartsstudio_02_0098__en-us_topic_0181629373_en-us_topic_0093082049_p15629937181358">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.68000000000001%" headers="mcps1.3.3.1.1.2.5.1.4 "><p id="dataartsstudio_02_0098__en-us_topic_0181629373_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_0098__en-us_topic_0181629373_row8529650193918"><td class="cellrowborder" valign="top" width="20.05%" headers="mcps1.3.3.1.1.2.5.1.1 "><p id="dataartsstudio_02_0098__en-us_topic_0181629373_p49561027135617">script_name</p>
</td>
<td class="cellrowborder" valign="top" width="10.41%" headers="mcps1.3.3.1.1.2.5.1.2 "><p id="dataartsstudio_02_0098__en-us_topic_0181629373_p1195613271566">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="15.86%" headers="mcps1.3.3.1.1.2.5.1.3 "><p id="dataartsstudio_02_0098__en-us_topic_0181629373_p421414825613">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.68000000000001%" headers="mcps1.3.3.1.1.2.5.1.4 "><p id="dataartsstudio_02_0098__en-us_topic_0181629373_p395617274566">Script name.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<div class="section" id="dataartsstudio_02_0098__en-us_topic_0181629373_section10789431145710"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dataartsstudio_02_0098__en-us_topic_0181629373_table25071810112414" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameter</caption><thead align="left"><tr id="dataartsstudio_02_0098__en-us_topic_0181629373_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_0098__en-us_topic_0181629373_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_0098__en-us_topic_0181629373_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_0098__en-us_topic_0181629373_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_0098__en-us_topic_0181629373_en-us_topic_0181281363_p11149331122017">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dataartsstudio_02_0098__en-us_topic_0181629373_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_0098__en-us_topic_0181629373_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_0098__en-us_topic_0181629373_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_0098__en-us_topic_0181629373_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_0098__en-us_topic_0181629373_en-us_topic_0181281363_p169341251122511">Workspace ID.</p>
<ul id="dataartsstudio_02_0098__en-us_topic_0181629373_en-us_topic_0181281363_ul776685742514"><li id="dataartsstudio_02_0098__en-us_topic_0181629373_en-us_topic_0181281363_li076655782516">If this parameter is not set, data in the <strong id="dataartsstudio_02_0098__b1283625094919">default</strong> workspace is queried by default.</li><li id="dataartsstudio_02_0098__en-us_topic_0181629373_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_0098__en-us_topic_0181629373_table11147115320104" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Script parameters</caption><thead align="left"><tr id="dataartsstudio_02_0098__en-us_topic_0181629373_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_0098__en-us_topic_0181629373_en-us_topic_0181281288_p1275244423417">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="9.75%" id="mcps1.3.4.3.2.5.1.2"><p id="dataartsstudio_02_0098__en-us_topic_0181629373_en-us_topic_0181281288_p1375504413341">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15.65%" id="mcps1.3.4.3.2.5.1.3"><p id="dataartsstudio_02_0098__en-us_topic_0181629373_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_0098__en-us_topic_0181629373_en-us_topic_0181281288_p475920448344">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dataartsstudio_02_0098__en-us_topic_0181629373_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_0098__en-us_topic_0181629373_en-us_topic_0181281288_p5760124443410">name</p>
</td>
<td class="cellrowborder" valign="top" width="9.75%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dataartsstudio_02_0098__en-us_topic_0181629373_en-us_topic_0181281288_p476174473411">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="15.65%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dataartsstudio_02_0098__en-us_topic_0181629373_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_0098__en-us_topic_0181629373_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_0098__en-us_topic_0181629373_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_0098__en-us_topic_0181629373_en-us_topic_0181281288_p1676464463414">type</p>
</td>
<td class="cellrowborder" valign="top" width="9.75%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dataartsstudio_02_0098__en-us_topic_0181629373_en-us_topic_0181281288_p776544410349">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="15.65%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dataartsstudio_02_0098__en-us_topic_0181629373_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_0098__en-us_topic_0181629373_en-us_topic_0181281288_p0767244123410">Script type.</p>
<ul id="dataartsstudio_02_0098__en-us_topic_0181629373_en-us_topic_0181281288_ul1276716442349"><li id="dataartsstudio_02_0098__en-us_topic_0181629373_en-us_topic_0181281288_li20216520017">FlinkSQL</li><li id="dataartsstudio_02_0098__en-us_topic_0181629373_en-us_topic_0181281288_li676811443344">DLISQL</li><li id="dataartsstudio_02_0098__en-us_topic_0181629373_en-us_topic_0181281288_li176818449341">SparkSQL</li><li id="dataartsstudio_02_0098__en-us_topic_0181629373_en-us_topic_0181281288_li4769644143416">HiveSQL</li><li id="dataartsstudio_02_0098__en-us_topic_0181629373_en-us_topic_0181281288_li9771844153414">DWSSQL</li><li id="dataartsstudio_02_0098__en-us_topic_0181629373_en-us_topic_0181281288_li16239115616513">RDSSQL</li><li id="dataartsstudio_02_0098__en-us_topic_0181629373_en-us_topic_0181281288_li167711644103416">Shell</li><li id="dataartsstudio_02_0098__li139001015121217">PRESTO</li><li id="dataartsstudio_02_0098__li935071551713">ClickHouseSQL</li><li id="dataartsstudio_02_0098__li354032511178">HetuEngineSQL</li><li id="dataartsstudio_02_0098__li631733210175">PYTHON</li><li id="dataartsstudio_02_0098__li586839101810">ImpalaSQL</li><li id="dataartsstudio_02_0098__li10215163117558">Spark Python</li></ul>
</td>
</tr>
<tr id="dataartsstudio_02_0098__en-us_topic_0181629373_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_0098__en-us_topic_0181629373_en-us_topic_0181281288_p1777284413346">content</p>
</td>
<td class="cellrowborder" valign="top" width="9.75%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dataartsstudio_02_0098__en-us_topic_0181629373_en-us_topic_0181281288_p11772184413346">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="15.65%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dataartsstudio_02_0098__en-us_topic_0181629373_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_0098__en-us_topic_0181629373_en-us_topic_0181281288_p7773124493414">Script content. A maximum of 4 MB is supported.</p>
</td>
</tr>
<tr id="dataartsstudio_02_0098__en-us_topic_0181629373_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_0098__en-us_topic_0181629373_en-us_topic_0181281288_p1141615072518">directory</p>
</td>
<td class="cellrowborder" valign="top" width="9.75%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dataartsstudio_02_0098__en-us_topic_0181629373_en-us_topic_0181281288_p1416120152512">No</p>
</td>
<td class="cellrowborder" valign="top" width="15.65%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dataartsstudio_02_0098__en-us_topic_0181629373_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_0098__en-us_topic_0181629373_en-us_topic_0181281288_p119211628765">Directory for storing the script.</p>
<p id="dataartsstudio_02_0098__en-us_topic_0181629373_en-us_topic_0181281288_p123051357125016">Access the <span id="dataartsstudio_02_0098__en-us_topic_0181629373_en-us_topic_0181281288_text17305185785010"><span id="dataartsstudio_02_0098__text17214194153610">DataArts Studio</span></span> console and choose <strong id="dataartsstudio_02_0098__b188491022123415">Data Development</strong>. In the left navigation pane, choose <span class="menucascade" id="dataartsstudio_02_0098__menucascade128491222343"><b><span class="uicontrol" id="dataartsstudio_02_0098__uicontrol68491122153417">Development</span></b> &gt; <b><span class="uicontrol" id="dataartsstudio_02_0098__uicontrol1184952233418">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_0098__b8745677452">root</strong> directory.</p>
</td>
</tr>
<tr id="dataartsstudio_02_0098__en-us_topic_0181629373_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_0098__en-us_topic_0181629373_en-us_topic_0181281288_p8774134411348">connectionName</p>
</td>
<td class="cellrowborder" valign="top" width="9.75%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dataartsstudio_02_0098__en-us_topic_0181629373_en-us_topic_0181281288_p12775644143410">No</p>
</td>
<td class="cellrowborder" valign="top" width="15.65%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dataartsstudio_02_0098__en-us_topic_0181629373_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_0098__en-us_topic_0181629373_en-us_topic_0181281288_p777614493418">Name of the connection associated with the script. This parameter is mandatory when <strong id="dataartsstudio_02_0098__b1983782425">type</strong> is set to <strong id="dataartsstudio_02_0098__b2841381429">DLISQL</strong>, <strong id="dataartsstudio_02_0098__b8879854215">SparkSQL</strong>, <strong id="dataartsstudio_02_0098__b8889814429">HiveSQL</strong>, <strong id="dataartsstudio_02_0098__b14906818425">DWSSQL</strong>, <strong id="dataartsstudio_02_0098__b99111820422">Shell</strong>, <strong id="dataartsstudio_02_0098__b393188104214">PRESTO</strong>, <strong id="dataartsstudio_02_0098__b1947819420">ClickHouseSQL</strong>, <strong id="dataartsstudio_02_0098__b179548144218">HetuEngineSQL</strong>, <strong id="dataartsstudio_02_0098__b10978820425">RDSSQL</strong>, <strong id="dataartsstudio_02_0098__b1699128184219">ImpalaSQL</strong>, <strong id="dataartsstudio_02_0098__b610113894214">Spark Python</strong>, or <strong id="dataartsstudio_02_0098__b1105986426">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_0098__en-us_topic_0181629373_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_0098__en-us_topic_0181629373_en-us_topic_0181281288_p11779144420343">database</p>
</td>
<td class="cellrowborder" valign="top" width="9.75%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dataartsstudio_02_0098__en-us_topic_0181629373_en-us_topic_0181281288_p677910447341">No</p>
</td>
<td class="cellrowborder" valign="top" width="15.65%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dataartsstudio_02_0098__en-us_topic_0181629373_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_0098__en-us_topic_0181629373_en-us_topic_0181281288_p111521459151915">Database associated with an SQL statement. This parameter is available only when <strong id="dataartsstudio_02_0098__b11678611134219">type</strong> is set to <strong id="dataartsstudio_02_0098__b196797119425">DLISQL</strong>, <strong id="dataartsstudio_02_0098__b1668271120428">SparkSQL</strong>, <strong id="dataartsstudio_02_0098__b7683411124215">HiveSQL</strong>, <strong id="dataartsstudio_02_0098__b468511144217">DWSSQL</strong>, <strong id="dataartsstudio_02_0098__b1568651114428">PRESTO</strong>, <strong id="dataartsstudio_02_0098__b66871111124219">RDSSQL</strong>, <strong id="dataartsstudio_02_0098__b26937115422">ClickHouseSQL</strong>, <strong id="dataartsstudio_02_0098__b86941711174210">ImpalaSQL</strong>, or <strong id="dataartsstudio_02_0098__b3696111184211">HetuEngineSQL</strong>.</p>
<ul id="dataartsstudio_02_0098__en-us_topic_0181629373_en-us_topic_0181281288_ul13121162217205"><li id="dataartsstudio_02_0098__en-us_topic_0181629373_en-us_topic_0181281288_li1112114221207">If <strong id="dataartsstudio_02_0098__b77431153123418">type</strong> is set to <strong id="dataartsstudio_02_0098__b274345383415">DLI SQL</strong>, obtain database information by calling the API for querying all databases in the <i><cite id="dataartsstudio_02_0098__en-us_topic_0181629373_en-us_topic_0181281288_cite78218241468">Data Lake Insight API Reference</cite></i>.</li><li id="dataartsstudio_02_0098__en-us_topic_0181629373_en-us_topic_0181281288_li1773516248207">Connect to the cluster in JDBC mode to query database information if <strong id="dataartsstudio_02_0098__b156318557347">type</strong> is not set to <strong id="dataartsstudio_02_0098__b463175510344">DLISQL</strong>. By default, this parameter is left blank.</li></ul>
</td>
</tr>
<tr id="dataartsstudio_02_0098__en-us_topic_0181629373_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_0098__en-us_topic_0181629373_en-us_topic_0181281288_p12781344123416">queueName</p>
</td>
<td class="cellrowborder" valign="top" width="9.75%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dataartsstudio_02_0098__en-us_topic_0181629373_en-us_topic_0181281288_p378154473415">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="15.65%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dataartsstudio_02_0098__en-us_topic_0181629373_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_0098__en-us_topic_0181629373_en-us_topic_0181281288_p2783144415348">Queue name of the DLI resource. This parameter is available only when <strong id="dataartsstudio_02_0098__b2041283334519">type</strong> is set to <strong id="dataartsstudio_02_0098__b204181133124515">DLISQL</strong>. You can obtain the queue information by calling the API for "Querying All Queues" in the <i><cite id="dataartsstudio_02_0098__en-us_topic_0181629373_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_0098__en-us_topic_0181629373_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_0098__en-us_topic_0181629373_en-us_topic_0181281288_p198419513419">configuration</p>
</td>
<td class="cellrowborder" valign="top" width="9.75%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dataartsstudio_02_0098__en-us_topic_0181629373_en-us_topic_0181281288_p284111512416">No</p>
</td>
<td class="cellrowborder" valign="top" width="15.65%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dataartsstudio_02_0098__en-us_topic_0181629373_en-us_topic_0181281288_p1884112584116">map &lt;String,Object&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="52.76%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dataartsstudio_02_0098__en-us_topic_0181629373_en-us_topic_0181281288_p59811446432">Configuration defined by a user for the job. This parameter is available only when <strong id="dataartsstudio_02_0098__b20598134424510">type</strong> is set to <strong id="dataartsstudio_02_0098__b146041044124519">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_0098__en-us_topic_0181629373_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_0098__en-us_topic_0181629373_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_0098__en-us_topic_0181629373_en-us_topic_0181281288_p12917141554414">description</p>
</td>
<td class="cellrowborder" valign="top" width="9.75%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dataartsstudio_02_0098__en-us_topic_0181629373_en-us_topic_0181281288_p2091720157442">No</p>
</td>
<td class="cellrowborder" valign="top" width="15.65%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dataartsstudio_02_0098__en-us_topic_0181629373_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_0098__en-us_topic_0181629373_en-us_topic_0181281288_p9917161515443">Description of the script. The description contains a maximum of 255 characters.</p>
</td>
</tr>
<tr id="dataartsstudio_02_0098__row18457141969"><td class="cellrowborder" valign="top" width="21.84%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dataartsstudio_02_0098__p175867202012">approvers</p>
</td>
<td class="cellrowborder" valign="top" width="9.75%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dataartsstudio_02_0098__p97581676203">No</p>
</td>
<td class="cellrowborder" valign="top" width="15.65%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dataartsstudio_02_0098__p77589714204">List&lt;JobApprover&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="52.76%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dataartsstudio_02_0098__p1829214412218">Script approver. This parameter is required if the review function is enabled. For details, see <a href="#dataartsstudio_02_0098__table943565132314">Table 4</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="dataartsstudio_02_0098__table943565132314"></a><a name="table943565132314"></a><table cellpadding="4" cellspacing="0" summary="" id="dataartsstudio_02_0098__table943565132314" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Approver attributes</caption><thead align="left"><tr id="dataartsstudio_02_0098__row3436125112238"><th align="left" class="cellrowborder" valign="top" width="24.95750424957504%" id="mcps1.3.4.4.2.5.1.1"><p id="dataartsstudio_02_0098__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_0098__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_0098__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_0098__p16603158192520">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dataartsstudio_02_0098__row7436175110233"><td class="cellrowborder" valign="top" width="24.95750424957504%" headers="mcps1.3.4.4.2.5.1.1 "><p id="dataartsstudio_02_0098__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_0098__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_0098__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_0098__p413162811253">Approver name</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="dataartsstudio_02_0098__en-us_topic_0181629373_section561243517589"><h4 class="sectiontitle">Response Parameters</h4><p id="dataartsstudio_02_0098__en-us_topic_0181629373_p7541145513348">None.</p>
</div>
<div class="section" id="dataartsstudio_02_0098__en-us_topic_0181629373_section358155716277"><h4 class="sectiontitle">Example Request</h4><div class="p" id="dataartsstudio_02_0098__en-us_topic_0181629373_p1488816432455">Modify a script named <strong id="dataartsstudio_02_0098__b1387203911819">echoTimeShell</strong> whose type is Shell, content is <strong id="dataartsstudio_02_0098__b7387123910815">echo a</strong>, and associated connection is <strong id="dataartsstudio_02_0098__b193876391189">con</strong>.<pre class="screen" id="dataartsstudio_02_0098__en-us_topic_0181629373_screen165211354306">PUT /v1/b384b9e9ab9b4ee8994c8633aabc9505/scripts/echoTimeShell
{
"name": "echoTimeShell",
"type": "Shell",
"content": "echo a",
"connectionName": "con"
}</pre>
</div>
</div>
<div class="p" id="dataartsstudio_02_0098__p628331314524">Change the script content when the review function is enabled.<pre class="screen" id="dataartsstudio_02_0098__screen1928361320526">PUT /v1/b384b9e9ab9b4ee8994c8633aabc9505/scripts/echoTimeShell
{
"name": "echoTimeShell",
"type": "Shell",
"content": "echo a",
"connectionName": "con",
"approvers": [
{
"approverName": "userName1"
},
{
"approverName": "userName2"
}
]
}</pre>
</div>
<div class="section" id="dataartsstudio_02_0098__section2039712433511"><h4 class="sectiontitle">Example Response</h4><ul id="dataartsstudio_02_0098__en-us_topic_0181629373_ul13130223205017"><li id="dataartsstudio_02_0098__en-us_topic_0181629373_li149491320463">Success response<p id="dataartsstudio_02_0098__en-us_topic_0181629373_p107513409317"><a name="dataartsstudio_02_0098__en-us_topic_0181629373_li149491320463"></a><a name="en-us_topic_0181629373_li149491320463"></a>HTTP status code 204</p>
</li><li id="dataartsstudio_02_0098__en-us_topic_0181629373_li313082312504">Failure response<p id="dataartsstudio_02_0098__en-us_topic_0181629373_p17868101111567"><a name="dataartsstudio_02_0098__en-us_topic_0181629373_li313082312504"></a><a name="en-us_topic_0181629373_li313082312504"></a>HTTP status code 400</p>
<pre class="screen" id="dataartsstudio_02_0098__en-us_topic_0181629373_screen2818105917308">{
"error_code":"DLF.6201",
"error_msg":"The script does not exist."
}</pre>
</li></ul>
</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>
View Git Blame Copy Permalink