forked from docs/doc-exports
Hongwei, King Wang
32c06a10a2
Reviewed-by: Sarda, Priya <prsarda@noreply.gitea.eco.tsi-dev.otc-service.com> Co-authored-by: Hongwei, King Wang <king.wanghongwei@huawei.com> Co-committed-by: Hongwei, King Wang <king.wanghongwei@huawei.com>
66 lines
6.8 KiB
HTML
66 lines
6.8 KiB
HTML
<a name="EN-US_TOPIC_0000001854169153"></a><a name="EN-US_TOPIC_0000001854169153"></a>
|
|
|
|
<h1 class="topictitle1">Deleting a VPN Connection</h1>
|
|
<div id="body8662426"><div class="section" id="EN-US_TOPIC_0000001854169153__en-us_topic_0000001594352969_section20114008"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000001854169153__en-us_topic_0000001594352969_p615910249113">This API is used to delete a VPN connection with a specified connection ID.</p>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001854169153__en-us_topic_0000001594352969_section18104173342818"><h4 class="sectiontitle">Calling Method</h4><p id="EN-US_TOPIC_0000001854169153__en-us_topic_0000001594352969_p19989133162813">For details, see <a href="vpn_api_0008.html#EN-US_TOPIC_0000001807530276">Calling APIs</a>.</p>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001854169153__en-us_topic_0000001594352969_section46808346"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0000001854169153__en-us_topic_0000001594352969_p526515453541">DELETE /v5/{project_id}/vpn-connection/{vpn_connection_id}</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001854169153__en-us_topic_0000001594352969_table3672032" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0000001854169153__en-us_topic_0000001594352969_row10026740"><th align="left" class="cellrowborder" valign="top" width="20.61793820617938%" id="mcps1.3.3.3.2.5.1.1"><p id="EN-US_TOPIC_0000001854169153__en-us_topic_0000001594352969_p6859639">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="19.02809719028097%" id="mcps1.3.3.3.2.5.1.2"><p id="EN-US_TOPIC_0000001854169153__en-us_topic_0000001594352969_p179611479215">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="11.798820117988202%" id="mcps1.3.3.3.2.5.1.3"><p id="EN-US_TOPIC_0000001854169153__en-us_topic_0000001594352969_p18759866">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="48.555144485551445%" id="mcps1.3.3.3.2.5.1.4"><p id="EN-US_TOPIC_0000001854169153__en-us_topic_0000001594352969_p43154149">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000001854169153__en-us_topic_0000001594352969_row5825185"><td class="cellrowborder" valign="top" width="20.61793820617938%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001854169153__en-us_topic_0000001594352969_p2077973">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.02809719028097%" headers="mcps1.3.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001854169153__en-us_topic_0000001594352969_p177965479212">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.798820117988202%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001854169153__en-us_topic_0000001594352969_p34098154">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.555144485551445%" headers="mcps1.3.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001854169153__en-us_topic_0000001594352969_p199639252285">Specifies a project ID. You can obtain the project ID by referring to <a href="vpn_api_0051.html#EN-US_TOPIC_0000001807530332">Obtaining the Project ID</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001854169153__en-us_topic_0000001594352969_row5625353135110"><td class="cellrowborder" valign="top" width="20.61793820617938%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001854169153__en-us_topic_0000001594352969_p201617241219">vpn_connection_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.02809719028097%" headers="mcps1.3.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001854169153__en-us_topic_0000001594352969_p616192419118">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.798820117988202%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001854169153__en-us_topic_0000001594352969_p1816262410117">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.555144485551445%" headers="mcps1.3.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001854169153__en-us_topic_0000001594352969_p1716214241818">Specifies a VPN connection ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001854169153__en-us_topic_0000001594352969_section18621933"><h4 class="sectiontitle">Request</h4><ul id="EN-US_TOPIC_0000001854169153__en-us_topic_0000001594352969_ul5992193374713"><li id="EN-US_TOPIC_0000001854169153__en-us_topic_0000001594352969_li1625615310133">Request parameters<p id="EN-US_TOPIC_0000001854169153__en-us_topic_0000001594352969_p1948025351311"><a name="EN-US_TOPIC_0000001854169153__en-us_topic_0000001594352969_li1625615310133"></a><a name="en-us_topic_0000001594352969_li1625615310133"></a>None</p>
|
|
</li><li id="EN-US_TOPIC_0000001854169153__en-us_topic_0000001594352969_li373614521173">Example request<pre class="screen" id="EN-US_TOPIC_0000001854169153__en-us_topic_0000001594352969_screen1778465375316">DELETE https://{Endpoint}/v5/{project_id}/vpn-connection/{vpn_connection_id}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001854169153__en-us_topic_0000001594352969_section33379675"><h4 class="sectiontitle">Response</h4><ul id="EN-US_TOPIC_0000001854169153__en-us_topic_0000001594352969_ul118061036143720"><li id="EN-US_TOPIC_0000001854169153__en-us_topic_0000001594352969_li14806936153714">Response parameters<p id="EN-US_TOPIC_0000001854169153__en-us_topic_0000001594352969_p1380603611372"><a name="EN-US_TOPIC_0000001854169153__en-us_topic_0000001594352969_li14806936153714"></a><a name="en-us_topic_0000001594352969_li14806936153714"></a>Returned status code 204: successful deletion</p>
|
|
</li><li id="EN-US_TOPIC_0000001854169153__en-us_topic_0000001594352969_li68061536123720">Example response<div class="p" id="EN-US_TOPIC_0000001854169153__en-us_topic_0000001594352969_p0241459236"><a name="EN-US_TOPIC_0000001854169153__en-us_topic_0000001594352969_li68061536123720"></a><a name="en-us_topic_0000001594352969_li68061536123720"></a>Response returned when a frozen VPN connection fails to be deleted<pre class="screen" id="EN-US_TOPIC_0000001854169153__en-us_topic_0000001594352969_screen979052972316">DELETE https://{Endpoint}/v5/{project_id}/vpn-connection/{vpn_connection_id}
|
|
|
|
{
|
|
"error_code":"VPN.0001",
|
|
"error_msg":"invalid request: ILLEGAL not allowed delete vpnConnection",
|
|
"request_id":"76b771cb-3b2a-151a-5bed-fdf5df12ff82"
|
|
}</pre>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001854169153__en-us_topic_0000001594352969_section31981619"><h4 class="sectiontitle">Status Codes</h4><p id="EN-US_TOPIC_0000001854169153__en-us_topic_0000001594352969_p18112112662914">For details, see <a href="vpn_api_0052.html#EN-US_TOPIC_0000001807370508">Status Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="vpn_api_0026.html">VPN Connection</a></div>
|
|
</div>
|
|
</div>
|
|
|