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>
153 lines
16 KiB
HTML
153 lines
16 KiB
HTML
<a name="dataartsstudio_02_0052"></a><a name="dataartsstudio_02_0052"></a>
|
|
|
|
<h1 class="topictitle1">Querying Connection Details (to Be Taken Offline)</h1>
|
|
<div id="body0000001151054605"><div class="note" id="dataartsstudio_02_0052__note1300192375913"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="dataartsstudio_02_0052__dataartsstudio_02_0050_p8251739103613">The connection management capability is provided by Management Center. APIs of Management Center are recommended.</p>
|
|
</div></div>
|
|
<div class="section" id="dataartsstudio_02_0052__en-us_topic_0181281352_section1738101810182"><h4 class="sectiontitle">Function</h4><p id="dataartsstudio_02_0052__en-us_topic_0181281352_p1912913467404">This API is used to query details of a connection.</p>
|
|
</div>
|
|
<div class="section" id="dataartsstudio_02_0052__en-us_topic_0181281352_section7934966101819"><h4 class="sectiontitle">URI</h4><ul id="dataartsstudio_02_0052__en-us_topic_0181281352_ul145591424184717"><li id="dataartsstudio_02_0052__en-us_topic_0181281352_li356152404715">URI format<p id="dataartsstudio_02_0052__en-us_topic_0181281352_p076674419427"><a name="dataartsstudio_02_0052__en-us_topic_0181281352_li356152404715"></a><a name="en-us_topic_0181281352_li356152404715"></a>GET /v1/{project_id}/connections/{connection_name}</p>
|
|
</li></ul>
|
|
</div>
|
|
<ul id="dataartsstudio_02_0052__en-us_topic_0181281352_ul1370917277482"><li id="dataartsstudio_02_0052__en-us_topic_0181281352_li170972720484">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dataartsstudio_02_0052__en-us_topic_0181281352_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_0052__en-us_topic_0181281352_en-us_topic_0093082049_row26974916181358"><th align="left" class="cellrowborder" valign="top" width="19.919999999999998%" id="mcps1.3.4.1.1.2.5.1.1"><p id="dataartsstudio_02_0052__en-us_topic_0181281352_en-us_topic_0093082049_p37484572181358">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="10.66%" id="mcps1.3.4.1.1.2.5.1.2"><p id="dataartsstudio_02_0052__en-us_topic_0181281352_en-us_topic_0093082049_p16351468181358">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15.740000000000002%" id="mcps1.3.4.1.1.2.5.1.3"><p id="dataartsstudio_02_0052__en-us_topic_0181281352_en-us_topic_0093082049_p49400541181358">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="53.68000000000001%" id="mcps1.3.4.1.1.2.5.1.4"><p id="dataartsstudio_02_0052__en-us_topic_0181281352_en-us_topic_0093082049_p42020886181358">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dataartsstudio_02_0052__en-us_topic_0181281352_en-us_topic_0093082049_row48248640181358"><td class="cellrowborder" valign="top" width="19.919999999999998%" headers="mcps1.3.4.1.1.2.5.1.1 "><p id="dataartsstudio_02_0052__en-us_topic_0181281352_en-us_topic_0093082049_p15825795181358">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.66%" headers="mcps1.3.4.1.1.2.5.1.2 "><p id="dataartsstudio_02_0052__en-us_topic_0181281352_en-us_topic_0093082049_p6820998181358">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.740000000000002%" headers="mcps1.3.4.1.1.2.5.1.3 "><p id="dataartsstudio_02_0052__en-us_topic_0181281352_en-us_topic_0093082049_p15629937181358">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.68000000000001%" headers="mcps1.3.4.1.1.2.5.1.4 "><p id="dataartsstudio_02_0052__en-us_topic_0181281352_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_0052__en-us_topic_0181281352_row1490392211329"><td class="cellrowborder" valign="top" width="19.919999999999998%" headers="mcps1.3.4.1.1.2.5.1.1 "><p id="dataartsstudio_02_0052__en-us_topic_0181281352_p149041422193215">connection_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.66%" headers="mcps1.3.4.1.1.2.5.1.2 "><p id="dataartsstudio_02_0052__en-us_topic_0181281352_p290412226324">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.740000000000002%" headers="mcps1.3.4.1.1.2.5.1.3 "><p id="dataartsstudio_02_0052__en-us_topic_0181281352_p189045226328">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.68000000000001%" headers="mcps1.3.4.1.1.2.5.1.4 "><p id="dataartsstudio_02_0052__en-us_topic_0181281352_p1990462219327">Name of a connection.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<div class="section" id="dataartsstudio_02_0052__en-us_topic_0181281352_section10789431145710"><h4 class="sectiontitle">Request Parameters</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dataartsstudio_02_0052__en-us_topic_0181281352_table25071810112414" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameter</caption><thead align="left"><tr id="dataartsstudio_02_0052__en-us_topic_0181281352_en-us_topic_0181281363_row3746915131710"><th align="left" class="cellrowborder" valign="top" width="15.010000000000002%" id="mcps1.3.5.2.2.5.1.1"><p id="dataartsstudio_02_0052__en-us_topic_0181281352_en-us_topic_0181281363_p131491731112013">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16.93%" id="mcps1.3.5.2.2.5.1.2"><p id="dataartsstudio_02_0052__en-us_topic_0181281352_en-us_topic_0181281363_p3149113112204">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18.73%" id="mcps1.3.5.2.2.5.1.3"><p id="dataartsstudio_02_0052__en-us_topic_0181281352_en-us_topic_0181281363_p13149173119204">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="49.33%" id="mcps1.3.5.2.2.5.1.4"><p id="dataartsstudio_02_0052__en-us_topic_0181281352_en-us_topic_0181281363_p11149331122017">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dataartsstudio_02_0052__en-us_topic_0181281352_en-us_topic_0181281363_row174620159179"><td class="cellrowborder" valign="top" width="15.010000000000002%" headers="mcps1.3.5.2.2.5.1.1 "><p id="dataartsstudio_02_0052__en-us_topic_0181281352_en-us_topic_0181281363_p1150183116205">workspace</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.93%" headers="mcps1.3.5.2.2.5.1.2 "><p id="dataartsstudio_02_0052__en-us_topic_0181281352_en-us_topic_0181281363_p4150531152016">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.73%" headers="mcps1.3.5.2.2.5.1.3 "><p id="dataartsstudio_02_0052__en-us_topic_0181281352_en-us_topic_0181281363_p181505317209">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.33%" headers="mcps1.3.5.2.2.5.1.4 "><p id="dataartsstudio_02_0052__en-us_topic_0181281352_en-us_topic_0181281363_p169341251122511">Workspace ID.</p>
|
|
<ul id="dataartsstudio_02_0052__en-us_topic_0181281352_en-us_topic_0181281363_ul776685742514"><li id="dataartsstudio_02_0052__en-us_topic_0181281352_en-us_topic_0181281363_li076655782516">If this parameter is not set, data in the <strong id="dataartsstudio_02_0052__b04471383292">default</strong> workspace is queried by default.</li><li id="dataartsstudio_02_0052__en-us_topic_0181281352_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_0052__en-us_topic_0181281352_section561243517589"><h4 class="sectiontitle">Response Parameters</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dataartsstudio_02_0052__en-us_topic_0181281352_table101225717013" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Connection parameters</caption><thead align="left"><tr id="dataartsstudio_02_0052__en-us_topic_0181281352_en-us_topic_0181281363_row1475134418345"><th align="left" class="cellrowborder" valign="top" width="21.51%" id="mcps1.3.6.2.2.5.1.1"><p id="dataartsstudio_02_0052__en-us_topic_0181281352_en-us_topic_0181281363_p1275244423417">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="9.959999999999999%" id="mcps1.3.6.2.2.5.1.2"><p id="dataartsstudio_02_0052__en-us_topic_0181281352_en-us_topic_0181281363_p1375504413341">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15.55%" id="mcps1.3.6.2.2.5.1.3"><p id="dataartsstudio_02_0052__en-us_topic_0181281352_en-us_topic_0181281363_p675774416349">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="52.980000000000004%" id="mcps1.3.6.2.2.5.1.4"><p id="dataartsstudio_02_0052__en-us_topic_0181281352_en-us_topic_0181281363_p475920448344">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dataartsstudio_02_0052__en-us_topic_0181281352_en-us_topic_0181281363_row1760344113410"><td class="cellrowborder" valign="top" width="21.51%" headers="mcps1.3.6.2.2.5.1.1 "><p id="dataartsstudio_02_0052__en-us_topic_0181281352_en-us_topic_0181281363_p5760124443410">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="9.959999999999999%" headers="mcps1.3.6.2.2.5.1.2 "><p id="dataartsstudio_02_0052__en-us_topic_0181281352_en-us_topic_0181281363_p476174473411">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.55%" headers="mcps1.3.6.2.2.5.1.3 "><p id="dataartsstudio_02_0052__en-us_topic_0181281352_en-us_topic_0181281363_p6763114463415">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.980000000000004%" headers="mcps1.3.6.2.2.5.1.4 "><p id="dataartsstudio_02_0052__en-us_topic_0181281352_en-us_topic_0181281363_p1376304411342">Connection name. The name contains a maximum of 100 characters, including only letters, numbers, hyphens (-), and underscores (_). The connection name must be unique.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dataartsstudio_02_0052__en-us_topic_0181281352_en-us_topic_0181281363_row7763244193418"><td class="cellrowborder" valign="top" width="21.51%" headers="mcps1.3.6.2.2.5.1.1 "><p id="dataartsstudio_02_0052__en-us_topic_0181281352_en-us_topic_0181281363_p1676464463414">type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="9.959999999999999%" headers="mcps1.3.6.2.2.5.1.2 "><p id="dataartsstudio_02_0052__en-us_topic_0181281352_en-us_topic_0181281363_p776544410349">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.55%" headers="mcps1.3.6.2.2.5.1.3 "><p id="dataartsstudio_02_0052__en-us_topic_0181281352_en-us_topic_0181281363_p7766174423419">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.980000000000004%" headers="mcps1.3.6.2.2.5.1.4 "><p id="dataartsstudio_02_0052__en-us_topic_0181281352_en-us_topic_0181281363_p0767244123410">Connection type.</p>
|
|
<ul id="dataartsstudio_02_0052__en-us_topic_0181281352_en-us_topic_0181281363_ul1276716442349"><li id="dataartsstudio_02_0052__en-us_topic_0181281352_en-us_topic_0181281363_li20216520017">DWS</li><li id="dataartsstudio_02_0052__en-us_topic_0181281352_en-us_topic_0181281363_li676811443344">DLI</li><li id="dataartsstudio_02_0052__en-us_topic_0181281352_en-us_topic_0181281363_li176818449341">SparkSQL</li><li id="dataartsstudio_02_0052__en-us_topic_0181281352_en-us_topic_0181281363_li4769644143416">HIVE</li><li id="dataartsstudio_02_0052__en-us_topic_0181281352_en-us_topic_0181281363_li9771844153414">RDS</li><li id="dataartsstudio_02_0052__en-us_topic_0181281352_en-us_topic_0181281363_li167711644103416">CloudTable</li><li id="dataartsstudio_02_0052__li944419264150">HOST</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="dataartsstudio_02_0052__en-us_topic_0181281352_en-us_topic_0181281363_row2416130182519"><td class="cellrowborder" valign="top" width="21.51%" headers="mcps1.3.6.2.2.5.1.1 "><p id="dataartsstudio_02_0052__en-us_topic_0181281352_en-us_topic_0181281363_p1141615072518">config</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="9.959999999999999%" headers="mcps1.3.6.2.2.5.1.2 "><p id="dataartsstudio_02_0052__en-us_topic_0181281352_en-us_topic_0181281363_p1416120152512">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.55%" headers="mcps1.3.6.2.2.5.1.3 "><p id="dataartsstudio_02_0052__en-us_topic_0181281352_en-us_topic_0181281363_p1228755515211">Map<String,String></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.980000000000004%" headers="mcps1.3.6.2.2.5.1.4 "><p id="dataartsstudio_02_0052__en-us_topic_0181281352_en-us_topic_0181281363_p74165052512">Connection configuration item. The configuration item varies with the connection type. You do not need to set the <strong id="dataartsstudio_02_0052__b18931195819346">config</strong> parameter for DLI connections. For other types of connections, see the description of connection configuration items.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dataartsstudio_02_0052__en-us_topic_0181281352_en-us_topic_0181281363_row291711515444"><td class="cellrowborder" valign="top" width="21.51%" headers="mcps1.3.6.2.2.5.1.1 "><p id="dataartsstudio_02_0052__en-us_topic_0181281352_en-us_topic_0181281363_p12917141554414">description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="9.959999999999999%" headers="mcps1.3.6.2.2.5.1.2 "><p id="dataartsstudio_02_0052__en-us_topic_0181281352_en-us_topic_0181281363_p2091720157442">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.55%" headers="mcps1.3.6.2.2.5.1.3 "><p id="dataartsstudio_02_0052__en-us_topic_0181281352_en-us_topic_0181281363_p1991714152448">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.980000000000004%" headers="mcps1.3.6.2.2.5.1.4 "><p id="dataartsstudio_02_0052__en-us_topic_0181281352_en-us_topic_0181281363_p9917161515443">Description of the connection. The description contains a maximum of 255 characters.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="dataartsstudio_02_0052__section19485325133215"><h4 class="sectiontitle">Example Request</h4><div class="p" id="dataartsstudio_02_0052__p18485152513216">Query connection details.<pre class="screen" id="dataartsstudio_02_0052__screen104859252321">GET /v1/b384b9e9ab9b4ee8994c8633aabc9505/connections/connection1</pre>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="dataartsstudio_02_0052__en-us_topic_0181281352_section358155716277"><h4 class="sectiontitle">Example Response</h4><ul id="dataartsstudio_02_0052__en-us_topic_0181281352_ul13130223205017"><li id="dataartsstudio_02_0052__en-us_topic_0181281352_li149491320463">Success response<p id="dataartsstudio_02_0052__en-us_topic_0181281352_p107513409317"><a name="dataartsstudio_02_0052__en-us_topic_0181281352_li149491320463"></a><a name="en-us_topic_0181281352_li149491320463"></a>HTTP status code 200</p>
|
|
<pre class="screen" id="dataartsstudio_02_0052__en-us_topic_0181281352_screen134017453193">{
|
|
"name":"connection1",
|
|
"type":"DWS",
|
|
"config":{
|
|
"clusterName":"test",
|
|
"userName":"dbadmin",
|
|
"password":"*********",
|
|
"kmsKey":"cdm-dlf",
|
|
"agentName":"cdm-donotdelete",
|
|
"sslEnable":false
|
|
}
|
|
}</pre>
|
|
</li><li id="dataartsstudio_02_0052__en-us_topic_0181281352_li697361214553">Failure response<p id="dataartsstudio_02_0052__en-us_topic_0181281352_p17868101111567"><a name="dataartsstudio_02_0052__en-us_topic_0181281352_li697361214553"></a><a name="en-us_topic_0181281352_li697361214553"></a>HTTP status code 400</p>
|
|
<pre class="screen" id="dataartsstudio_02_0052__en-us_topic_0181281352_screen2818105917308">{
|
|
"error_code":"DLF.6322",
|
|
"error_msg":"The data connection does not exist."
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="dataartsstudio_02_0052__en-us_topic_0181281352_section1623417185013"><h4 class="sectiontitle">Status Codes</h4><p id="dataartsstudio_02_0052__en-us_topic_0181281352_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_0049.html">Connection Management APIs (To Be Taken Offline)</a></div>
|
|
</div>
|
|
</div>
|
|
|