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>
204 lines
24 KiB
HTML
204 lines
24 KiB
HTML
<a name="dataartsstudio_02_0099"></a><a name="dataartsstudio_02_0099"></a>
|
|
|
|
<h1 class="topictitle1">Querying a Script</h1>
|
|
<div id="body0000001104814548"><div class="section" id="dataartsstudio_02_0099__en-us_topic_0181281324_section1738101810182"><h4 class="sectiontitle">Function</h4><p id="dataartsstudio_02_0099__en-us_topic_0181281324_p1912913467404">This API is used to query a script, including the script type and script content.</p>
|
|
</div>
|
|
<div class="section" id="dataartsstudio_02_0099__en-us_topic_0181281324_section7934966101819"><h4 class="sectiontitle">URI</h4><ul id="dataartsstudio_02_0099__en-us_topic_0181281324_ul145591424184717"><li id="dataartsstudio_02_0099__en-us_topic_0181281324_li356152404715">URI format<p id="dataartsstudio_02_0099__en-us_topic_0181281324_p076674419427"><a name="dataartsstudio_02_0099__en-us_topic_0181281324_li356152404715"></a><a name="en-us_topic_0181281324_li356152404715"></a>GET /v1/{project_id}/scripts/{script_name}</p>
|
|
</li></ul>
|
|
<ul id="dataartsstudio_02_0099__en-us_topic_0181281324_ul1370917277482"><li id="dataartsstudio_02_0099__en-us_topic_0181281324_li170972720484">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dataartsstudio_02_0099__en-us_topic_0181281324_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_0099__en-us_topic_0181281324_en-us_topic_0093082049_row26974916181358"><th align="left" class="cellrowborder" valign="top" width="19.8%" id="mcps1.3.2.3.1.1.2.5.1.1"><p id="dataartsstudio_02_0099__en-us_topic_0181281324_en-us_topic_0093082049_p37484572181358">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="10.66%" id="mcps1.3.2.3.1.1.2.5.1.2"><p id="dataartsstudio_02_0099__en-us_topic_0181281324_en-us_topic_0093082049_p16351468181358">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16.12%" id="mcps1.3.2.3.1.1.2.5.1.3"><p id="dataartsstudio_02_0099__en-us_topic_0181281324_en-us_topic_0093082049_p49400541181358">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="53.42%" id="mcps1.3.2.3.1.1.2.5.1.4"><p id="dataartsstudio_02_0099__en-us_topic_0181281324_en-us_topic_0093082049_p42020886181358">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dataartsstudio_02_0099__en-us_topic_0181281324_en-us_topic_0093082049_row48248640181358"><td class="cellrowborder" valign="top" width="19.8%" headers="mcps1.3.2.3.1.1.2.5.1.1 "><p id="dataartsstudio_02_0099__en-us_topic_0181281324_en-us_topic_0093082049_p15825795181358">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.66%" headers="mcps1.3.2.3.1.1.2.5.1.2 "><p id="dataartsstudio_02_0099__en-us_topic_0181281324_en-us_topic_0093082049_p6820998181358">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.12%" headers="mcps1.3.2.3.1.1.2.5.1.3 "><p id="dataartsstudio_02_0099__en-us_topic_0181281324_en-us_topic_0093082049_p15629937181358">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.42%" headers="mcps1.3.2.3.1.1.2.5.1.4 "><p id="dataartsstudio_02_0099__en-us_topic_0181281324_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_0099__en-us_topic_0181281324_row29566273563"><td class="cellrowborder" valign="top" width="19.8%" headers="mcps1.3.2.3.1.1.2.5.1.1 "><p id="dataartsstudio_02_0099__en-us_topic_0181281324_p49561027135617">script_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.66%" headers="mcps1.3.2.3.1.1.2.5.1.2 "><p id="dataartsstudio_02_0099__en-us_topic_0181281324_p1195613271566">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.12%" headers="mcps1.3.2.3.1.1.2.5.1.3 "><p id="dataartsstudio_02_0099__en-us_topic_0181281324_p421414825613">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.42%" headers="mcps1.3.2.3.1.1.2.5.1.4 "><p id="dataartsstudio_02_0099__en-us_topic_0181281324_p395617274566">Script name.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="dataartsstudio_02_0099__en-us_topic_0181281324_section10789431145710"><h4 class="sectiontitle">Request Parameters</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dataartsstudio_02_0099__en-us_topic_0181281324_table25071810112414" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameter</caption><thead align="left"><tr id="dataartsstudio_02_0099__en-us_topic_0181281324_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_0099__en-us_topic_0181281324_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_0099__en-us_topic_0181281324_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_0099__en-us_topic_0181281324_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_0099__en-us_topic_0181281324_en-us_topic_0181281363_p11149331122017">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dataartsstudio_02_0099__en-us_topic_0181281324_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_0099__en-us_topic_0181281324_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_0099__en-us_topic_0181281324_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_0099__en-us_topic_0181281324_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_0099__en-us_topic_0181281324_en-us_topic_0181281363_p169341251122511">Workspace ID.</p>
|
|
<ul id="dataartsstudio_02_0099__en-us_topic_0181281324_en-us_topic_0181281363_ul776685742514"><li id="dataartsstudio_02_0099__en-us_topic_0181281324_en-us_topic_0181281363_li076655782516">If this parameter is not set, data in the <strong id="dataartsstudio_02_0099__b07133567457">default</strong> workspace is queried by default.</li><li id="dataartsstudio_02_0099__en-us_topic_0181281324_en-us_topic_0181281363_li788605918251">To query data in other workspaces, this header must be carried.</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="dataartsstudio_02_0099__en-us_topic_0181281324_section561243517589"><h4 class="sectiontitle">Response Parameters</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dataartsstudio_02_0099__en-us_topic_0181281324_table5402926105715" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Script parameters</caption><thead align="left"><tr id="dataartsstudio_02_0099__en-us_topic_0181281324_en-us_topic_0181281288_row1475134418345"><th align="left" class="cellrowborder" valign="top" width="21.84%" id="mcps1.3.4.2.2.5.1.1"><p id="dataartsstudio_02_0099__en-us_topic_0181281324_en-us_topic_0181281288_p1275244423417">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="9.75%" id="mcps1.3.4.2.2.5.1.2"><p id="dataartsstudio_02_0099__en-us_topic_0181281324_en-us_topic_0181281288_p1375504413341">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15.65%" id="mcps1.3.4.2.2.5.1.3"><p id="dataartsstudio_02_0099__en-us_topic_0181281324_en-us_topic_0181281288_p675774416349">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="52.76%" id="mcps1.3.4.2.2.5.1.4"><p id="dataartsstudio_02_0099__en-us_topic_0181281324_en-us_topic_0181281288_p475920448344">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dataartsstudio_02_0099__en-us_topic_0181281324_en-us_topic_0181281288_row1760344113410"><td class="cellrowborder" valign="top" width="21.84%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dataartsstudio_02_0099__en-us_topic_0181281324_en-us_topic_0181281288_p5760124443410">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="9.75%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dataartsstudio_02_0099__en-us_topic_0181281324_en-us_topic_0181281288_p476174473411">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.65%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dataartsstudio_02_0099__en-us_topic_0181281324_en-us_topic_0181281288_p6763114463415">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.76%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dataartsstudio_02_0099__en-us_topic_0181281324_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_0099__en-us_topic_0181281324_en-us_topic_0181281288_row7763244193418"><td class="cellrowborder" valign="top" width="21.84%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dataartsstudio_02_0099__en-us_topic_0181281324_en-us_topic_0181281288_p1676464463414">type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="9.75%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dataartsstudio_02_0099__en-us_topic_0181281324_en-us_topic_0181281288_p776544410349">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.65%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dataartsstudio_02_0099__en-us_topic_0181281324_en-us_topic_0181281288_p7766174423419">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.76%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dataartsstudio_02_0099__en-us_topic_0181281324_en-us_topic_0181281288_p0767244123410">Script type.</p>
|
|
<ul id="dataartsstudio_02_0099__en-us_topic_0181281324_en-us_topic_0181281288_ul1276716442349"><li id="dataartsstudio_02_0099__en-us_topic_0181281324_en-us_topic_0181281288_li20216520017">FlinkSQL</li><li id="dataartsstudio_02_0099__en-us_topic_0181281324_en-us_topic_0181281288_li676811443344">DLISQL</li><li id="dataartsstudio_02_0099__en-us_topic_0181281324_en-us_topic_0181281288_li176818449341">SparkSQL</li><li id="dataartsstudio_02_0099__en-us_topic_0181281324_en-us_topic_0181281288_li4769644143416">HiveSQL</li><li id="dataartsstudio_02_0099__en-us_topic_0181281324_en-us_topic_0181281288_li9771844153414">DWSSQL</li><li id="dataartsstudio_02_0099__en-us_topic_0181281324_en-us_topic_0181281288_li16239115616513">RDSSQL</li><li id="dataartsstudio_02_0099__en-us_topic_0181281324_en-us_topic_0181281288_li167711644103416">Shell</li><li id="dataartsstudio_02_0099__li113312303544">PRESTO</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="dataartsstudio_02_0099__en-us_topic_0181281324_en-us_topic_0181281288_row10979193913289"><td class="cellrowborder" valign="top" width="21.84%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dataartsstudio_02_0099__en-us_topic_0181281324_en-us_topic_0181281288_p1777284413346">content</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="9.75%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dataartsstudio_02_0099__en-us_topic_0181281324_en-us_topic_0181281288_p11772184413346">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.65%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dataartsstudio_02_0099__en-us_topic_0181281324_en-us_topic_0181281288_p11773194420340">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.76%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dataartsstudio_02_0099__en-us_topic_0181281324_en-us_topic_0181281288_p7773124493414">Script content. A maximum of 64 KB is supported.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dataartsstudio_02_0099__en-us_topic_0181281324_en-us_topic_0181281288_row2416130182519"><td class="cellrowborder" valign="top" width="21.84%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dataartsstudio_02_0099__en-us_topic_0181281324_en-us_topic_0181281288_p1141615072518">directory</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="9.75%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dataartsstudio_02_0099__en-us_topic_0181281324_en-us_topic_0181281288_p1416120152512">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.65%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dataartsstudio_02_0099__en-us_topic_0181281324_en-us_topic_0181281288_p2416001259">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.76%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dataartsstudio_02_0099__en-us_topic_0181281324_en-us_topic_0181281288_p119211628765">Directory for storing the script.</p>
|
|
<p id="dataartsstudio_02_0099__en-us_topic_0181281324_en-us_topic_0181281288_p123051357125016">Access the <span id="dataartsstudio_02_0099__text156271964365"><span id="dataartsstudio_02_0099__text0627462369">DataArts Studio</span></span> console and choose <strong id="dataartsstudio_02_0099__b96271861368">DataArts Factory</strong>. In the left navigation pane, choose <span class="menucascade" id="dataartsstudio_02_0099__menucascade66281610366"><b><span class="uicontrol" id="dataartsstudio_02_0099__uicontrol1862816693610">Development</span></b> > <b><span class="uicontrol" id="dataartsstudio_02_0099__uicontrol76284618367">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_0099__b1384115141467">root</strong> directory.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dataartsstudio_02_0099__en-us_topic_0181281324_en-us_topic_0181281288_row97741244163419"><td class="cellrowborder" valign="top" width="21.84%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dataartsstudio_02_0099__en-us_topic_0181281324_en-us_topic_0181281288_p8774134411348">connectionName</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="9.75%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dataartsstudio_02_0099__en-us_topic_0181281324_en-us_topic_0181281288_p12775644143410">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.65%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dataartsstudio_02_0099__en-us_topic_0181281324_en-us_topic_0181281288_p187761344173415">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.76%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dataartsstudio_02_0099__en-us_topic_0181281324_en-us_topic_0181281288_p777614493418">Name of the connection associated with the script. This parameter is mandatory when <strong id="dataartsstudio_02_0099__b163741910103611">type</strong> is set to <strong id="dataartsstudio_02_0099__b2374131018360">DLISQL</strong>, <strong id="dataartsstudio_02_0099__b5375910193614">SparkSQL</strong>, <strong id="dataartsstudio_02_0099__b10375151013611">HiveSQL</strong>, <strong id="dataartsstudio_02_0099__b1375121017366">DWSSQL</strong>, <strong id="dataartsstudio_02_0099__b437641012361">Shell</strong>, or <strong id="dataartsstudio_02_0099__b13763106365">PRESTO</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_0099__en-us_topic_0181281324_en-us_topic_0181281288_row47771744133413"><td class="cellrowborder" valign="top" width="21.84%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dataartsstudio_02_0099__en-us_topic_0181281324_en-us_topic_0181281288_p11779144420343">database</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="9.75%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dataartsstudio_02_0099__en-us_topic_0181281324_en-us_topic_0181281288_p677910447341">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.65%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dataartsstudio_02_0099__en-us_topic_0181281324_en-us_topic_0181281288_p6779744113415">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.76%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dataartsstudio_02_0099__en-us_topic_0181281324_en-us_topic_0181281288_p111521459151915">Database associated with an SQL statement. This parameter is available only when <strong id="dataartsstudio_02_0099__b1771916149362">type</strong> is set to <strong id="dataartsstudio_02_0099__b37201814153614">DLISQL</strong>, <strong id="dataartsstudio_02_0099__b87205142364">SparkSQL</strong>, <strong id="dataartsstudio_02_0099__b1772001453611">HiveSQL</strong>, or <strong id="dataartsstudio_02_0099__b1772110149367">DWSSQL</strong>.</p>
|
|
<ul id="dataartsstudio_02_0099__en-us_topic_0181281324_en-us_topic_0181281288_ul13121162217205"><li id="dataartsstudio_02_0099__en-us_topic_0181281324_en-us_topic_0181281288_li1112114221207">If <strong id="dataartsstudio_02_0099__b933904017366">type</strong> is set to <strong id="dataartsstudio_02_0099__b933912409367">DLISQL</strong>, obtain database information by calling the API for querying all databases in the <i><cite id="dataartsstudio_02_0099__en-us_topic_0181281324_en-us_topic_0181281288_cite78218241468">Data Lake Insight API Reference</cite></i>.</li><li id="dataartsstudio_02_0099__en-us_topic_0181281324_en-us_topic_0181281288_li1773516248207">Connect to the cluster in JDBC mode to query database information if <strong id="dataartsstudio_02_0099__b57974111373">type</strong> is not set to <strong id="dataartsstudio_02_0099__b1579791111370">DLISQL</strong>. By default, this parameter is left blank.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="dataartsstudio_02_0099__en-us_topic_0181281324_en-us_topic_0181281288_row19780644113415"><td class="cellrowborder" valign="top" width="21.84%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dataartsstudio_02_0099__en-us_topic_0181281324_en-us_topic_0181281288_p12781344123416">queueName</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="9.75%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dataartsstudio_02_0099__en-us_topic_0181281324_en-us_topic_0181281288_p378154473415">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.65%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dataartsstudio_02_0099__en-us_topic_0181281324_en-us_topic_0181281288_p47824441349">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.76%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dataartsstudio_02_0099__en-us_topic_0181281324_en-us_topic_0181281288_p2783144415348">Queue name of the DLI resource. This parameter is available only when <strong id="dataartsstudio_02_0099__b3545113815463">type</strong> is set to <strong id="dataartsstudio_02_0099__b65511438134616">DLISQL</strong>. You can obtain the queue information by calling the API for "Querying All Queues" in the <i><cite id="dataartsstudio_02_0099__en-us_topic_0181281324_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_0099__en-us_topic_0181281324_en-us_topic_0181281288_row1684095184113"><td class="cellrowborder" valign="top" width="21.84%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dataartsstudio_02_0099__en-us_topic_0181281324_en-us_topic_0181281288_p198419513419">configuration</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="9.75%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dataartsstudio_02_0099__en-us_topic_0181281324_en-us_topic_0181281288_p284111512416">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.65%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dataartsstudio_02_0099__en-us_topic_0181281324_en-us_topic_0181281288_p1884112584116">map <String,Object></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.76%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dataartsstudio_02_0099__en-us_topic_0181281324_en-us_topic_0181281288_p59811446432">Configuration defined by a user for the job. This parameter is available only when <strong id="dataartsstudio_02_0099__b779517420466">type</strong> is set to <strong id="dataartsstudio_02_0099__b147961142134612">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_0099__en-us_topic_0181281324_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_0099__en-us_topic_0181281324_en-us_topic_0181281288_row291711515444"><td class="cellrowborder" valign="top" width="21.84%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dataartsstudio_02_0099__en-us_topic_0181281324_en-us_topic_0181281288_p12917141554414">description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="9.75%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dataartsstudio_02_0099__en-us_topic_0181281324_en-us_topic_0181281288_p2091720157442">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.65%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dataartsstudio_02_0099__en-us_topic_0181281324_en-us_topic_0181281288_p1991714152448">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.76%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dataartsstudio_02_0099__en-us_topic_0181281324_en-us_topic_0181281288_p9917161515443">Description of the script. The description contains a maximum of 255 characters.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dataartsstudio_02_0099__row89836361027"><td class="cellrowborder" valign="top" width="21.84%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dataartsstudio_02_0099__p39848361027">autoAcquireLock</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="9.75%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dataartsstudio_02_0099__p598414367212">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.65%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dataartsstudio_02_0099__p15984183619216">boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.76%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dataartsstudio_02_0099__p1298415361724">Whether to automatically obtain the edit lock parameters. The default value is <strong id="dataartsstudio_02_0099__b19438125311182">true</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="dataartsstudio_02_0099__en-us_topic_0181281324_section358155716277"><h4 class="sectiontitle">Example Request</h4><pre class="screen" id="dataartsstudio_02_0099__en-us_topic_0181281324_screen165211354306">GET /v1/b384b9e9ab9b4ee8994c8633aabc9505/scripts/scriptName</pre>
|
|
</div>
|
|
<div class="section" id="dataartsstudio_02_0099__section64124599516"><h4 class="sectiontitle">Example Response</h4><ul id="dataartsstudio_02_0099__ul10412459185113"><li id="dataartsstudio_02_0099__li441205919514">Success response<div class="p" id="dataartsstudio_02_0099__p1341275955116"><a name="dataartsstudio_02_0099__li441205919514"></a><a name="li441205919514"></a>HTTP status code 200<pre class="screen" id="dataartsstudio_02_0099__screen17412195965110">{
|
|
"configuration":{},
|
|
"connectionName":"mrs_spark",
|
|
"content":"SELECT 1;",
|
|
"database":"aaa",
|
|
"description":"",
|
|
"directory":"/",
|
|
"name":"mrs_spark_sql",
|
|
"type":"SparkSQL"
|
|
}</pre>
|
|
</div>
|
|
</li><li id="dataartsstudio_02_0099__li13412125985110">Failure response<p id="dataartsstudio_02_0099__p441214595518"><a name="dataartsstudio_02_0099__li13412125985110"></a><a name="li13412125985110"></a>HTTP status code 400</p>
|
|
<pre class="screen" id="dataartsstudio_02_0099__screen11412259145118">{
|
|
"error_code":"DLF.6201",
|
|
"error_msg":"The script does not exist."
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="dataartsstudio_02_0099__en-us_topic_0181281324_section14634192495516"><h4 class="sectiontitle">Status Codes</h4><p id="dataartsstudio_02_0099__en-us_topic_0181281324_p770710383559">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>
|
|
|