vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/dataartsstudio/api-ref/dataartsstudio_02_0100.html
Xiong, Chen Xiao f2733178cc DataArts API 20230329 version 
Reviewed-by: Kacur, Michal <michal.kacur@t-systems.com>
Co-authored-by: Xiong, Chen Xiao <chenxiaoxiong@huawei.com>
Co-committed-by: Xiong, Chen Xiao <chenxiaoxiong@huawei.com>
2023-06-29 16:21:21 +00:00

250 lines
28 KiB
HTML
Raw Blame History

<a name="dataartsstudio_02_0100"></a><a name="dataartsstudio_02_0100"></a>
<h1 class="topictitle1">Querying a Script List</h1>
<div id="body0000001151054645"><div class="section" id="dataartsstudio_02_0100__en-us_topic_0181496606_section1738101810182"><h4 class="sectiontitle">Function</h4><p id="dataartsstudio_02_0100__en-us_topic_0181496606_p1912913467404">This API is used to query the script list. A maximum of 1000 scripts can be returned for each query.</p>
</div>
<div class="section" id="dataartsstudio_02_0100__en-us_topic_0181496606_section7934966101819"><h4 class="sectiontitle">URI</h4><ul id="dataartsstudio_02_0100__en-us_topic_0181496606_ul145591424184717"><li id="dataartsstudio_02_0100__en-us_topic_0181496606_li356152404715">URI format<p id="dataartsstudio_02_0100__en-us_topic_0181496606_p076674419427"><a name="dataartsstudio_02_0100__en-us_topic_0181496606_li356152404715"></a><a name="en-us_topic_0181496606_li356152404715"></a>GET /v1/{project_id}/scripts?offset={offset}&amp;limit={limit}&amp;scriptName={scriptName}</p>
</li></ul>
</div>
<ul id="dataartsstudio_02_0100__en-us_topic_0181496606_ul1370917277482"><li id="dataartsstudio_02_0100__en-us_topic_0181496606_li170972720484">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dataartsstudio_02_0100__en-us_topic_0181496606_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_0100__en-us_topic_0181496606_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_0100__en-us_topic_0181496606_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_0100__en-us_topic_0181496606_en-us_topic_0093082049_p16351468181358">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15.989999999999998%" id="mcps1.3.3.1.1.2.5.1.3"><p id="dataartsstudio_02_0100__en-us_topic_0181496606_en-us_topic_0093082049_p49400541181358">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53.55%" id="mcps1.3.3.1.1.2.5.1.4"><p id="dataartsstudio_02_0100__en-us_topic_0181496606_en-us_topic_0093082049_p42020886181358">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dataartsstudio_02_0100__en-us_topic_0181496606_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_0100__en-us_topic_0181496606_en-us_topic_0093082049_p15825795181358">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="10.41%" headers="mcps1.3.3.1.1.2.5.1.2 "><p id="dataartsstudio_02_0100__en-us_topic_0181496606_en-us_topic_0093082049_p6820998181358">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="15.989999999999998%" headers="mcps1.3.3.1.1.2.5.1.3 "><p id="dataartsstudio_02_0100__en-us_topic_0181496606_en-us_topic_0093082049_p15629937181358">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.55%" headers="mcps1.3.3.1.1.2.5.1.4 "><p id="dataartsstudio_02_0100__en-us_topic_0181496606_p8672138175612">Project ID. For details about how to obtain a project ID, see <a href="dataartsstudio_02_0314.html">Project ID and Account ID</a>.</p>
</td>
</tr>
<tr id="dataartsstudio_02_0100__row736704915558"><td class="cellrowborder" valign="top" width="20.05%" headers="mcps1.3.3.1.1.2.5.1.1 "><p id="dataartsstudio_02_0100__en-us_topic_0181496606_p1791101344">limit</p>
</td>
<td class="cellrowborder" valign="top" width="10.41%" headers="mcps1.3.3.1.1.2.5.1.2 "><p id="dataartsstudio_02_0100__en-us_topic_0181496606_p15911902344">No</p>
</td>
<td class="cellrowborder" valign="top" width="15.989999999999998%" headers="mcps1.3.3.1.1.2.5.1.3 "><p id="dataartsstudio_02_0100__en-us_topic_0181496606_p2910020345">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="53.55%" headers="mcps1.3.3.1.1.2.5.1.4 "><p id="dataartsstudio_02_0100__en-us_topic_0181496606_p13217857560">The maximum number of records on each page. The value ranges from 1 to 100.</p>
<p id="dataartsstudio_02_0100__en-us_topic_0181496606_p163642582342">Default value: <strong id="dataartsstudio_02_0100__b183531658162810">10</strong></p>
</td>
</tr>
<tr id="dataartsstudio_02_0100__en-us_topic_0181496606_row43741615978"><td class="cellrowborder" valign="top" width="20.05%" headers="mcps1.3.3.1.1.2.5.1.1 "><p id="dataartsstudio_02_0100__en-us_topic_0181496606_p29173616317">offset</p>
</td>
<td class="cellrowborder" valign="top" width="10.41%" headers="mcps1.3.3.1.1.2.5.1.2 "><p id="dataartsstudio_02_0100__en-us_topic_0181496606_p1199365312">No</p>
</td>
<td class="cellrowborder" valign="top" width="15.989999999999998%" headers="mcps1.3.3.1.1.2.5.1.3 "><p id="dataartsstudio_02_0100__en-us_topic_0181496606_p1091036113110">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="53.55%" headers="mcps1.3.3.1.1.2.5.1.4 "><p id="dataartsstudio_02_0100__en-us_topic_0181496606_p10414726166">Start page of the paging list. The default value is <strong id="dataartsstudio_02_0100__b694792412315">0</strong>. The value must be greater than or equal to <strong id="dataartsstudio_02_0100__b19153192719319">0</strong>.</p>
</td>
</tr>
<tr id="dataartsstudio_02_0100__en-us_topic_0181496606_row663514256501"><td class="cellrowborder" valign="top" width="20.05%" headers="mcps1.3.3.1.1.2.5.1.1 "><p id="dataartsstudio_02_0100__en-us_topic_0181496606_p563562585020">scriptName</p>
</td>
<td class="cellrowborder" valign="top" width="10.41%" headers="mcps1.3.3.1.1.2.5.1.2 "><p id="dataartsstudio_02_0100__en-us_topic_0181496606_p10635192514508">No</p>
</td>
<td class="cellrowborder" valign="top" width="15.989999999999998%" headers="mcps1.3.3.1.1.2.5.1.3 "><p id="dataartsstudio_02_0100__en-us_topic_0181496606_p8636425115016">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.55%" headers="mcps1.3.3.1.1.2.5.1.4 "><p id="dataartsstudio_02_0100__en-us_topic_0181496606_p116361825135018">Script name.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<div class="section" id="dataartsstudio_02_0100__en-us_topic_0181496606_section10789431145710"><h4 class="sectiontitle">Request</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dataartsstudio_02_0100__en-us_topic_0181496606_table25071810112414" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameter</caption><thead align="left"><tr id="dataartsstudio_02_0100__en-us_topic_0181496606_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_0100__en-us_topic_0181496606_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_0100__en-us_topic_0181496606_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_0100__en-us_topic_0181496606_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_0100__en-us_topic_0181496606_en-us_topic_0181281363_p11149331122017">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dataartsstudio_02_0100__en-us_topic_0181496606_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_0100__en-us_topic_0181496606_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_0100__en-us_topic_0181496606_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_0100__en-us_topic_0181496606_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_0100__en-us_topic_0181496606_en-us_topic_0181281363_p169341251122511">Workspace ID.</p>
<ul id="dataartsstudio_02_0100__en-us_topic_0181496606_en-us_topic_0181281363_ul776685742514"><li id="dataartsstudio_02_0100__en-us_topic_0181496606_en-us_topic_0181281363_li076655782516">If this parameter is not set, data in the <strong id="dataartsstudio_02_0100__b125161854164610">default</strong> workspace is queried by default.</li><li id="dataartsstudio_02_0100__en-us_topic_0181496606_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_0100__en-us_topic_0181496606_section561243517589"><h4 class="sectiontitle">Response</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dataartsstudio_02_0100__en-us_topic_0181496606_table19750184493418" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response parameters</caption><thead align="left"><tr id="dataartsstudio_02_0100__en-us_topic_0181496606_row1475134418345"><th align="left" class="cellrowborder" valign="top" width="21.63%" id="mcps1.3.5.2.2.5.1.1"><p id="dataartsstudio_02_0100__en-us_topic_0181496606_p1275244423417">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_0100__en-us_topic_0181496606_p1375504413341">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15.310000000000002%" id="mcps1.3.5.2.2.5.1.3"><p id="dataartsstudio_02_0100__en-us_topic_0181496606_p675774416349">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="52.849999999999994%" id="mcps1.3.5.2.2.5.1.4"><p id="dataartsstudio_02_0100__en-us_topic_0181496606_p475920448344">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dataartsstudio_02_0100__en-us_topic_0181496606_row1760344113410"><td class="cellrowborder" valign="top" width="21.63%" headers="mcps1.3.5.2.2.5.1.1 "><p id="dataartsstudio_02_0100__en-us_topic_0181496606_p1882062017363">total</p>
</td>
<td class="cellrowborder" valign="top" width="10.209999999999999%" headers="mcps1.3.5.2.2.5.1.2 "><p id="dataartsstudio_02_0100__en-us_topic_0181496606_p17819122015363">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="15.310000000000002%" headers="mcps1.3.5.2.2.5.1.3 "><p id="dataartsstudio_02_0100__en-us_topic_0181496606_p10818220103616">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="52.849999999999994%" headers="mcps1.3.5.2.2.5.1.4 "><p id="dataartsstudio_02_0100__en-us_topic_0181496606_p19818102093611">The total number of scripts.</p>
</td>
</tr>
<tr id="dataartsstudio_02_0100__en-us_topic_0181496606_row7763244193418"><td class="cellrowborder" valign="top" width="21.63%" headers="mcps1.3.5.2.2.5.1.1 "><p id="dataartsstudio_02_0100__en-us_topic_0181496606_p681792083611">scripts</p>
</td>
<td class="cellrowborder" valign="top" width="10.209999999999999%" headers="mcps1.3.5.2.2.5.1.2 "><p id="dataartsstudio_02_0100__en-us_topic_0181496606_p6816620143613">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="15.310000000000002%" headers="mcps1.3.5.2.2.5.1.3 "><p id="dataartsstudio_02_0100__en-us_topic_0181496606_p1981682023611">List&lt;Script&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="52.849999999999994%" headers="mcps1.3.5.2.2.5.1.4 "><p id="dataartsstudio_02_0100__en-us_topic_0181496606_p148151920153616">A list of scripts.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dataartsstudio_02_0100__en-us_topic_0181496606_table186641025101918" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Script parameters</caption><thead align="left"><tr id="dataartsstudio_02_0100__en-us_topic_0181496606_en-us_topic_0181281288_row1475134418345"><th align="left" class="cellrowborder" valign="top" width="21.84%" id="mcps1.3.5.3.2.5.1.1"><p id="dataartsstudio_02_0100__en-us_topic_0181496606_en-us_topic_0181281288_p1275244423417">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="9.75%" id="mcps1.3.5.3.2.5.1.2"><p id="dataartsstudio_02_0100__en-us_topic_0181496606_en-us_topic_0181281288_p1375504413341">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15.65%" id="mcps1.3.5.3.2.5.1.3"><p id="dataartsstudio_02_0100__en-us_topic_0181496606_en-us_topic_0181281288_p675774416349">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="52.76%" id="mcps1.3.5.3.2.5.1.4"><p id="dataartsstudio_02_0100__en-us_topic_0181496606_en-us_topic_0181281288_p475920448344">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dataartsstudio_02_0100__en-us_topic_0181496606_en-us_topic_0181281288_row1760344113410"><td class="cellrowborder" valign="top" width="21.84%" headers="mcps1.3.5.3.2.5.1.1 "><p id="dataartsstudio_02_0100__en-us_topic_0181496606_en-us_topic_0181281288_p5760124443410">name</p>
</td>
<td class="cellrowborder" valign="top" width="9.75%" headers="mcps1.3.5.3.2.5.1.2 "><p id="dataartsstudio_02_0100__en-us_topic_0181496606_en-us_topic_0181281288_p476174473411">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="15.65%" headers="mcps1.3.5.3.2.5.1.3 "><p id="dataartsstudio_02_0100__en-us_topic_0181496606_en-us_topic_0181281288_p6763114463415">String</p>
</td>
<td class="cellrowborder" valign="top" width="52.76%" headers="mcps1.3.5.3.2.5.1.4 "><p id="dataartsstudio_02_0100__en-us_topic_0181496606_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_0100__en-us_topic_0181496606_en-us_topic_0181281288_row7763244193418"><td class="cellrowborder" valign="top" width="21.84%" headers="mcps1.3.5.3.2.5.1.1 "><p id="dataartsstudio_02_0100__en-us_topic_0181496606_en-us_topic_0181281288_p1676464463414">type</p>
</td>
<td class="cellrowborder" valign="top" width="9.75%" headers="mcps1.3.5.3.2.5.1.2 "><p id="dataartsstudio_02_0100__en-us_topic_0181496606_en-us_topic_0181281288_p776544410349">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="15.65%" headers="mcps1.3.5.3.2.5.1.3 "><p id="dataartsstudio_02_0100__en-us_topic_0181496606_en-us_topic_0181281288_p7766174423419">String</p>
</td>
<td class="cellrowborder" valign="top" width="52.76%" headers="mcps1.3.5.3.2.5.1.4 "><p id="dataartsstudio_02_0100__en-us_topic_0181496606_en-us_topic_0181281288_p0767244123410">Script type.</p>
<ul id="dataartsstudio_02_0100__en-us_topic_0181496606_en-us_topic_0181281288_ul1276716442349"><li id="dataartsstudio_02_0100__en-us_topic_0181496606_en-us_topic_0181281288_li20216520017">FlinkSQL</li><li id="dataartsstudio_02_0100__en-us_topic_0181496606_en-us_topic_0181281288_li676811443344">DLISQL</li><li id="dataartsstudio_02_0100__en-us_topic_0181496606_en-us_topic_0181281288_li176818449341">SparkSQL</li><li id="dataartsstudio_02_0100__en-us_topic_0181496606_en-us_topic_0181281288_li4769644143416">HiveSQL</li><li id="dataartsstudio_02_0100__en-us_topic_0181496606_en-us_topic_0181281288_li9771844153414">DWSSQL</li><li id="dataartsstudio_02_0100__en-us_topic_0181496606_en-us_topic_0181281288_li16239115616513">RDSSQL</li><li id="dataartsstudio_02_0100__en-us_topic_0181496606_en-us_topic_0181281288_li167711644103416">Shell</li><li id="dataartsstudio_02_0100__li12346171312588">PRESTO</li></ul>
</td>
</tr>
<tr id="dataartsstudio_02_0100__en-us_topic_0181496606_en-us_topic_0181281288_row10979193913289"><td class="cellrowborder" valign="top" width="21.84%" headers="mcps1.3.5.3.2.5.1.1 "><p id="dataartsstudio_02_0100__en-us_topic_0181496606_en-us_topic_0181281288_p1777284413346">content</p>
</td>
<td class="cellrowborder" valign="top" width="9.75%" headers="mcps1.3.5.3.2.5.1.2 "><p id="dataartsstudio_02_0100__en-us_topic_0181496606_en-us_topic_0181281288_p11772184413346">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="15.65%" headers="mcps1.3.5.3.2.5.1.3 "><p id="dataartsstudio_02_0100__en-us_topic_0181496606_en-us_topic_0181281288_p11773194420340">String</p>
</td>
<td class="cellrowborder" valign="top" width="52.76%" headers="mcps1.3.5.3.2.5.1.4 "><p id="dataartsstudio_02_0100__en-us_topic_0181496606_en-us_topic_0181281288_p7773124493414">Script content. A maximum of 64 KB is supported.</p>
</td>
</tr>
<tr id="dataartsstudio_02_0100__en-us_topic_0181496606_en-us_topic_0181281288_row2416130182519"><td class="cellrowborder" valign="top" width="21.84%" headers="mcps1.3.5.3.2.5.1.1 "><p id="dataartsstudio_02_0100__en-us_topic_0181496606_en-us_topic_0181281288_p1141615072518">directory</p>
</td>
<td class="cellrowborder" valign="top" width="9.75%" headers="mcps1.3.5.3.2.5.1.2 "><p id="dataartsstudio_02_0100__en-us_topic_0181496606_en-us_topic_0181281288_p1416120152512">No</p>
</td>
<td class="cellrowborder" valign="top" width="15.65%" headers="mcps1.3.5.3.2.5.1.3 "><p id="dataartsstudio_02_0100__en-us_topic_0181496606_en-us_topic_0181281288_p2416001259">String</p>
</td>
<td class="cellrowborder" valign="top" width="52.76%" headers="mcps1.3.5.3.2.5.1.4 "><p id="dataartsstudio_02_0100__en-us_topic_0181496606_en-us_topic_0181281288_p119211628765">Directory for storing the script.</p>
<p id="dataartsstudio_02_0100__en-us_topic_0181496606_en-us_topic_0181281288_p123051357125016">Access the <span id="dataartsstudio_02_0100__text1928982917372"><span id="dataartsstudio_02_0100__text828922903715">DataArts Studio</span></span> console and choose <strong id="dataartsstudio_02_0100__b4290152923714">DataArts Factory</strong>. In the left navigation pane, choose <span class="menucascade" id="dataartsstudio_02_0100__menucascade1291202923715"><b><span class="uicontrol" id="dataartsstudio_02_0100__uicontrol14290112911371">Development</span></b> &gt; <b><span class="uicontrol" id="dataartsstudio_02_0100__uicontrol192901529183711">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_0100__b1734966174711">root</strong> directory.</p>
</td>
</tr>
<tr id="dataartsstudio_02_0100__en-us_topic_0181496606_en-us_topic_0181281288_row97741244163419"><td class="cellrowborder" valign="top" width="21.84%" headers="mcps1.3.5.3.2.5.1.1 "><p id="dataartsstudio_02_0100__en-us_topic_0181496606_en-us_topic_0181281288_p8774134411348">connectionName</p>
</td>
<td class="cellrowborder" valign="top" width="9.75%" headers="mcps1.3.5.3.2.5.1.2 "><p id="dataartsstudio_02_0100__en-us_topic_0181496606_en-us_topic_0181281288_p12775644143410">No</p>
</td>
<td class="cellrowborder" valign="top" width="15.65%" headers="mcps1.3.5.3.2.5.1.3 "><p id="dataartsstudio_02_0100__en-us_topic_0181496606_en-us_topic_0181281288_p187761344173415">String</p>
</td>
<td class="cellrowborder" valign="top" width="52.76%" headers="mcps1.3.5.3.2.5.1.4 "><p id="dataartsstudio_02_0100__en-us_topic_0181496606_en-us_topic_0181281288_p777614493418">Name of the connection associated with the script. This parameter is mandatory when <strong id="dataartsstudio_02_0100__b1855330143713">type</strong> is set to <strong id="dataartsstudio_02_0100__b0855113003712">DLISQL</strong>, <strong id="dataartsstudio_02_0100__b11856103017372">SparkSQL</strong>, <strong id="dataartsstudio_02_0100__b58561130183711">HiveSQL</strong>, <strong id="dataartsstudio_02_0100__b485603011372">DWSSQL</strong>, <strong id="dataartsstudio_02_0100__b2857183013370">Shell</strong>, or <strong id="dataartsstudio_02_0100__b20857230143717">PRESTO</strong>. To obtain the existing connections, refer to the instructions in <a href="dataartsstudio_02_0051.html">Querying a Connection List</a>. By default, this parameter is left blank.</p>
</td>
</tr>
<tr id="dataartsstudio_02_0100__en-us_topic_0181496606_en-us_topic_0181281288_row47771744133413"><td class="cellrowborder" valign="top" width="21.84%" headers="mcps1.3.5.3.2.5.1.1 "><p id="dataartsstudio_02_0100__en-us_topic_0181496606_en-us_topic_0181281288_p11779144420343">database</p>
</td>
<td class="cellrowborder" valign="top" width="9.75%" headers="mcps1.3.5.3.2.5.1.2 "><p id="dataartsstudio_02_0100__en-us_topic_0181496606_en-us_topic_0181281288_p677910447341">No</p>
</td>
<td class="cellrowborder" valign="top" width="15.65%" headers="mcps1.3.5.3.2.5.1.3 "><p id="dataartsstudio_02_0100__en-us_topic_0181496606_en-us_topic_0181281288_p6779744113415">String</p>
</td>
<td class="cellrowborder" valign="top" width="52.76%" headers="mcps1.3.5.3.2.5.1.4 "><p id="dataartsstudio_02_0100__en-us_topic_0181496606_en-us_topic_0181281288_p111521459151915">Database associated with an SQL statement. This parameter is available only when <strong id="dataartsstudio_02_0100__b675619326377">type</strong> is set to <strong id="dataartsstudio_02_0100__b1875663214374">DLISQL</strong>, <strong id="dataartsstudio_02_0100__b19757113203720">SparkSQL</strong>, <strong id="dataartsstudio_02_0100__b07570326371">HiveSQL</strong>, <strong id="dataartsstudio_02_0100__b2758113217374">DWSSQL</strong>, or <strong id="dataartsstudio_02_0100__b975810321376">PRESTO</strong>.</p>
<ul id="dataartsstudio_02_0100__en-us_topic_0181496606_en-us_topic_0181281288_ul13121162217205"><li id="dataartsstudio_02_0100__en-us_topic_0181496606_en-us_topic_0181281288_li1112114221207">If <strong id="dataartsstudio_02_0100__b85459349378">type</strong> is set to <strong id="dataartsstudio_02_0100__b954653411373">DLISQL</strong>, obtain database information by calling the API for "Querying All Databases" in the <i><cite id="dataartsstudio_02_0100__en-us_topic_0181496606_en-us_topic_0181281288_cite78218241468">Data Lake Insight API Reference</cite></i>.</li><li id="dataartsstudio_02_0100__en-us_topic_0181496606_en-us_topic_0181281288_li1773516248207">If <strong id="dataartsstudio_02_0100__b1169014157478">type</strong> is not set to <strong id="dataartsstudio_02_0100__b15690201512474">DLISQL</strong>, connect to the cluster in JDBC mode to query database information. By default, this parameter is left blank.</li></ul>
</td>
</tr>
<tr id="dataartsstudio_02_0100__en-us_topic_0181496606_en-us_topic_0181281288_row19780644113415"><td class="cellrowborder" valign="top" width="21.84%" headers="mcps1.3.5.3.2.5.1.1 "><p id="dataartsstudio_02_0100__en-us_topic_0181496606_en-us_topic_0181281288_p12781344123416">queueName</p>
</td>
<td class="cellrowborder" valign="top" width="9.75%" headers="mcps1.3.5.3.2.5.1.2 "><p id="dataartsstudio_02_0100__en-us_topic_0181496606_en-us_topic_0181281288_p378154473415">No</p>
</td>
<td class="cellrowborder" valign="top" width="15.65%" headers="mcps1.3.5.3.2.5.1.3 "><p id="dataartsstudio_02_0100__en-us_topic_0181496606_en-us_topic_0181281288_p47824441349">String</p>
</td>
<td class="cellrowborder" valign="top" width="52.76%" headers="mcps1.3.5.3.2.5.1.4 "><p id="dataartsstudio_02_0100__en-us_topic_0181496606_en-us_topic_0181281288_p2783144415348">Queue name of the DLI resource. This parameter is available only when <strong id="dataartsstudio_02_0100__b123918176470">type</strong> is set to <strong id="dataartsstudio_02_0100__b539215172474">DLISQL</strong>. You can obtain the queue information by calling the API for "Querying All Queues" in the <i><cite id="dataartsstudio_02_0100__en-us_topic_0181496606_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_0100__en-us_topic_0181496606_en-us_topic_0181281288_row1684095184113"><td class="cellrowborder" valign="top" width="21.84%" headers="mcps1.3.5.3.2.5.1.1 "><p id="dataartsstudio_02_0100__en-us_topic_0181496606_en-us_topic_0181281288_p198419513419">configuration</p>
</td>
<td class="cellrowborder" valign="top" width="9.75%" headers="mcps1.3.5.3.2.5.1.2 "><p id="dataartsstudio_02_0100__en-us_topic_0181496606_en-us_topic_0181281288_p284111512416">No</p>
</td>
<td class="cellrowborder" valign="top" width="15.65%" headers="mcps1.3.5.3.2.5.1.3 "><p id="dataartsstudio_02_0100__en-us_topic_0181496606_en-us_topic_0181281288_p1884112584116">map &lt;String,Object&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="52.76%" headers="mcps1.3.5.3.2.5.1.4 "><p id="dataartsstudio_02_0100__en-us_topic_0181496606_en-us_topic_0181281288_p59811446432">Configuration defined by a user for the job. This parameter is available only when <strong id="dataartsstudio_02_0100__b1067112194714">type</strong> is set to <strong id="dataartsstudio_02_0100__b667192118472">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_0100__en-us_topic_0181496606_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_0100__en-us_topic_0181496606_en-us_topic_0181281288_row291711515444"><td class="cellrowborder" valign="top" width="21.84%" headers="mcps1.3.5.3.2.5.1.1 "><p id="dataartsstudio_02_0100__en-us_topic_0181496606_en-us_topic_0181281288_p12917141554414">description</p>
</td>
<td class="cellrowborder" valign="top" width="9.75%" headers="mcps1.3.5.3.2.5.1.2 "><p id="dataartsstudio_02_0100__en-us_topic_0181496606_en-us_topic_0181281288_p2091720157442">No</p>
</td>
<td class="cellrowborder" valign="top" width="15.65%" headers="mcps1.3.5.3.2.5.1.3 "><p id="dataartsstudio_02_0100__en-us_topic_0181496606_en-us_topic_0181281288_p1991714152448">String</p>
</td>
<td class="cellrowborder" valign="top" width="52.76%" headers="mcps1.3.5.3.2.5.1.4 "><p id="dataartsstudio_02_0100__en-us_topic_0181496606_en-us_topic_0181281288_p9917161515443">Description of the script. The description contains a maximum of 255 characters.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="dataartsstudio_02_0100__en-us_topic_0181496606_section358155716277"><h4 class="sectiontitle">Example</h4><p id="dataartsstudio_02_0100__en-us_topic_0181496606_p1488816432455">Query a script list.</p>
<ul id="dataartsstudio_02_0100__en-us_topic_0181496606_ul18736591462"><li id="dataartsstudio_02_0100__en-us_topic_0181496606_li47367914616">Request<pre class="screen" id="dataartsstudio_02_0100__en-us_topic_0181496606_screen165211354306">GET /v1/b384b9e9ab9b4ee8994c8633aabc9505/scripts</pre>
</li></ul>
</div>
<ul id="dataartsstudio_02_0100__en-us_topic_0181496606_ul13130223205017"><li id="dataartsstudio_02_0100__en-us_topic_0181496606_li149491320463">Success response<p id="dataartsstudio_02_0100__en-us_topic_0181496606_p107513409317"><a name="dataartsstudio_02_0100__en-us_topic_0181496606_li149491320463"></a><a name="en-us_topic_0181496606_li149491320463"></a>HTTP status code 200</p>
<pre class="screen" id="dataartsstudio_02_0100__zh-cn_topic_0181496606_screen134017453193">{
"total": 1,
"scripts": [
{
"configuration": {},
"connectionName": "mrs_spark",
"content": "SELECT 1;",
"database": "aaa",
"description": "",
"directory": "/",
"name": "mrs_spark_sql",
"type": "SparkSQL"
}
]
}</pre>
</li><li id="dataartsstudio_02_0100__en-us_topic_0181496606_li697361214553">Failure response<p id="dataartsstudio_02_0100__en-us_topic_0181496606_p17868101111567"><a name="dataartsstudio_02_0100__en-us_topic_0181496606_li697361214553"></a><a name="en-us_topic_0181496606_li697361214553"></a>HTTP status code 400</p>
<pre class="screen" id="dataartsstudio_02_0100__en-us_topic_0181496606_screen2818105917308">{
"error_code":"DLF.3051",
"error_msg":"The request parameter is invalid."
}</pre>
</li></ul>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="dataartsstudio_02_0083.html">APIs to Be Taken Offline</a></div>
</div>
</div>
View Git Blame Copy Permalink