doc-exports/docs/dataartsstudio/api-ref/dataartsstudio_02_0054.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

84 lines
8.4 KiB
HTML

<a name="dataartsstudio_02_0054"></a><a name="dataartsstudio_02_0054"></a>
<h1 class="topictitle1">Deleting a Connection (to Be Taken Offline)</h1>
<div id="body0000001104494702"><div class="note" id="dataartsstudio_02_0054__note1300192375913"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="dataartsstudio_02_0054__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_0054__en-us_topic_0181281367_section1738101810182"><h4 class="sectiontitle">Function</h4><p id="dataartsstudio_02_0054__en-us_topic_0181281367_p1912913467404">This API is used to delete a connection.</p>
</div>
<div class="section" id="dataartsstudio_02_0054__en-us_topic_0181281367_section7934966101819"><h4 class="sectiontitle">URI</h4><ul id="dataartsstudio_02_0054__en-us_topic_0181281367_ul145591424184717"><li id="dataartsstudio_02_0054__en-us_topic_0181281367_li356152404715">URI format<p id="dataartsstudio_02_0054__en-us_topic_0181281367_p076674419427"><a name="dataartsstudio_02_0054__en-us_topic_0181281367_li356152404715"></a><a name="en-us_topic_0181281367_li356152404715"></a>DELETE /v1/{project_id}/connections/{connection_name}</p>
</li></ul>
</div>
<ul id="dataartsstudio_02_0054__en-us_topic_0181281367_ul1370917277482"><li id="dataartsstudio_02_0054__en-us_topic_0181281367_li170972720484">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dataartsstudio_02_0054__en-us_topic_0181281367_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_0054__en-us_topic_0181281367_en-us_topic_0093082049_row26974916181358"><th align="left" class="cellrowborder" valign="top" width="20.43%" id="mcps1.3.4.1.1.2.5.1.1"><p id="dataartsstudio_02_0054__en-us_topic_0181281367_en-us_topic_0093082049_p37484572181358">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="10.03%" id="mcps1.3.4.1.1.2.5.1.2"><p id="dataartsstudio_02_0054__en-us_topic_0181281367_en-us_topic_0093082049_p16351468181358">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.24%" id="mcps1.3.4.1.1.2.5.1.3"><p id="dataartsstudio_02_0054__en-us_topic_0181281367_en-us_topic_0093082049_p49400541181358">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53.300000000000004%" id="mcps1.3.4.1.1.2.5.1.4"><p id="dataartsstudio_02_0054__en-us_topic_0181281367_en-us_topic_0093082049_p42020886181358">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dataartsstudio_02_0054__en-us_topic_0181281367_en-us_topic_0093082049_row48248640181358"><td class="cellrowborder" valign="top" width="20.43%" headers="mcps1.3.4.1.1.2.5.1.1 "><p id="dataartsstudio_02_0054__en-us_topic_0181281367_en-us_topic_0093082049_p15825795181358">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="10.03%" headers="mcps1.3.4.1.1.2.5.1.2 "><p id="dataartsstudio_02_0054__en-us_topic_0181281367_en-us_topic_0093082049_p6820998181358">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="16.24%" headers="mcps1.3.4.1.1.2.5.1.3 "><p id="dataartsstudio_02_0054__en-us_topic_0181281367_en-us_topic_0093082049_p15629937181358">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.300000000000004%" headers="mcps1.3.4.1.1.2.5.1.4 "><p id="dataartsstudio_02_0054__en-us_topic_0181281367_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_0054__en-us_topic_0181281367_row1490392211329"><td class="cellrowborder" valign="top" width="20.43%" headers="mcps1.3.4.1.1.2.5.1.1 "><p id="dataartsstudio_02_0054__en-us_topic_0181281367_p149041422193215">connection_name</p>
</td>
<td class="cellrowborder" valign="top" width="10.03%" headers="mcps1.3.4.1.1.2.5.1.2 "><p id="dataartsstudio_02_0054__en-us_topic_0181281367_p290412226324">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="16.24%" headers="mcps1.3.4.1.1.2.5.1.3 "><p id="dataartsstudio_02_0054__en-us_topic_0181281367_p189045226328">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.300000000000004%" headers="mcps1.3.4.1.1.2.5.1.4 "><p id="dataartsstudio_02_0054__en-us_topic_0181281367_p1990462219327">Name of a connection.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<div class="section" id="dataartsstudio_02_0054__en-us_topic_0181281367_section10789431145710"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dataartsstudio_02_0054__en-us_topic_0181281367_table25071810112414" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameter</caption><thead align="left"><tr id="dataartsstudio_02_0054__en-us_topic_0181281367_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_0054__en-us_topic_0181281367_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_0054__en-us_topic_0181281367_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_0054__en-us_topic_0181281367_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_0054__en-us_topic_0181281367_en-us_topic_0181281363_p11149331122017">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dataartsstudio_02_0054__en-us_topic_0181281367_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_0054__en-us_topic_0181281367_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_0054__en-us_topic_0181281367_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_0054__en-us_topic_0181281367_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_0054__en-us_topic_0181281367_en-us_topic_0181281363_p169341251122511">Workspace ID.</p>
<ul id="dataartsstudio_02_0054__en-us_topic_0181281367_en-us_topic_0181281363_ul776685742514"><li id="dataartsstudio_02_0054__en-us_topic_0181281367_en-us_topic_0181281363_li076655782516">If this parameter is not set, data in the <strong id="dataartsstudio_02_0054__b12881359228">default</strong> workspace is queried by default.</li><li id="dataartsstudio_02_0054__en-us_topic_0181281367_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_0054__en-us_topic_0181281367_section561243517589"><h4 class="sectiontitle">Response Parameters</h4><p id="dataartsstudio_02_0054__en-us_topic_0181281367_p7541145513348">None.</p>
</div>
<div class="section" id="dataartsstudio_02_0054__en-us_topic_0181281367_section358155716277"><h4 class="sectiontitle">Example Request</h4><div class="p" id="dataartsstudio_02_0054__en-us_topic_0181281367_p1488816432455">Delete the connection.<pre class="screen" id="dataartsstudio_02_0054__en-us_topic_0181281367_screen165211354306">DELETE /v1/b384b9e9ab9b4ee8994c8633aabc9505/connections/connection1</pre>
</div>
</div>
<div class="section" id="dataartsstudio_02_0054__section13691194935618"><h4 class="sectiontitle">Example Response</h4><p id="dataartsstudio_02_0054__p118625816568">Success response</p>
<p id="dataartsstudio_02_0054__en-us_topic_0181281367_p107513409317">HTTP status code 204</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>