doc-exports/docs/vpn/api-ref/vpn_api_1034.html
Hongwei, King Wang 32c06a10a2 vpn_api
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>
2024-08-15 14:18:28 +00:00

51 lines
5.2 KiB
HTML

<a name="EN-US_TOPIC_0000001854089265"></a><a name="EN-US_TOPIC_0000001854089265"></a>
<h1 class="topictitle1">Deleting a VPN Service</h1>
<div id="body8662426"><div class="section" id="EN-US_TOPIC_0000001854089265__en-us_topic_0000001591896525_section28812104"><h4 class="sectiontitle"><strong id="EN-US_TOPIC_0000001854089265__en-us_topic_0000001591896525_b842352706112523">Function</strong></h4><p id="EN-US_TOPIC_0000001854089265__en-us_topic_0000001591896525_p8605860">This interface is used to delete a VPN service.</p>
<div class="note" id="EN-US_TOPIC_0000001854089265__en-us_topic_0000001591896525_note148314312490"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="EN-US_TOPIC_0000001854089265__en-us_topic_0000001591896525_p1915519434914">This interface cannot be used to delete a VPN service in the active-active VPN scenarios.</p>
</div></div>
</div>
<div class="section" id="EN-US_TOPIC_0000001854089265__en-us_topic_0000001591896525_section57982344"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0000001854089265__en-us_topic_0000001591896525_p554918358482">DELETE /v2.0/vpn/vpnservices/{service_id}</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001854089265__en-us_topic_0000001591896525_table184162115335" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0000001854089265__en-us_topic_0000001591896525_row984914219336"><th align="left" class="cellrowborder" valign="top" width="25.507449255074494%" id="mcps1.3.2.3.2.5.1.1"><p id="EN-US_TOPIC_0000001854089265__en-us_topic_0000001591896525_p8849921163313"><strong id="EN-US_TOPIC_0000001854089265__en-us_topic_0000001591896525_b842352706172115">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.288571142885711%" id="mcps1.3.2.3.2.5.1.2"><p id="EN-US_TOPIC_0000001854089265__en-us_topic_0000001591896525_p384918214339">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.288571142885711%" id="mcps1.3.2.3.2.5.1.3"><p id="EN-US_TOPIC_0000001854089265__en-us_topic_0000001591896525_p208493212330">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="45.91540845915409%" id="mcps1.3.2.3.2.5.1.4"><p id="EN-US_TOPIC_0000001854089265__en-us_topic_0000001591896525_p1185732118339">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001854089265__en-us_topic_0000001591896525_row10857162110332"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.2.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001854089265__en-us_topic_0000001591896525_p17857142117336">service_id</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.2.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001854089265__en-us_topic_0000001591896525_p18857152173311">String</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.2.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001854089265__en-us_topic_0000001591896525_p385772133310">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.2.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001854089265__en-us_topic_0000001591896525_p28642214334">Specifies the VPN service ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001854089265__en-us_topic_0000001591896525_section66058249"><h4 class="sectiontitle">Request Message</h4><p id="EN-US_TOPIC_0000001854089265__en-us_topic_0000001591896525_p1354972651812">None</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001854089265__en-us_topic_0000001591896525_section57653332"><h4 class="sectiontitle">Response Message</h4><p id="EN-US_TOPIC_0000001854089265__en-us_topic_0000001591896525_p31910573">None</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001854089265__en-us_topic_0000001591896525_section49117947"><h4 class="sectiontitle">Example</h4><ul id="EN-US_TOPIC_0000001854089265__en-us_topic_0000001591896525_ul1390811484495"><li id="EN-US_TOPIC_0000001854089265__en-us_topic_0000001591896525_li390894884914">Example Request</li></ul>
<pre class="screen" id="EN-US_TOPIC_0000001854089265__en-us_topic_0000001591896525_screen30492010">DELETE v2.0/vpn/vpnservices/{service_id}</pre>
</div>
<ul id="EN-US_TOPIC_0000001854089265__en-us_topic_0000001591896525_ul14366123611818"><li id="EN-US_TOPIC_0000001854089265__en-us_topic_0000001591896525_li113662366187">Example Response<p id="EN-US_TOPIC_0000001854089265__en-us_topic_0000001591896525_p86338461182"><a name="EN-US_TOPIC_0000001854089265__en-us_topic_0000001591896525_li113662366187"></a><a name="en-us_topic_0000001591896525_li113662366187"></a>None</p>
</li></ul>
<div class="section" id="EN-US_TOPIC_0000001854089265__en-us_topic_0000001591896525_section6578292"><h4 class="sectiontitle">Returned Values</h4><p id="EN-US_TOPIC_0000001854089265__en-us_topic_0000001591896525_en-us_topic_0053740035_p19515943486">For details, see section <a href="vpn_api_1054.html#EN-US_TOPIC_0000001854089293">Common Returned Values</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="vpn_api_1029.html">VPN Service Management</a></div>
</div>
</div>