doc-exports/docs/vpn/api-ref/vpn_api_0036.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

59 lines
6.5 KiB
HTML

<a name="EN-US_TOPIC_0000001854089205"></a><a name="EN-US_TOPIC_0000001854089205"></a>
<h1 class="topictitle1">Deleting a VPN Connection Monitor</h1>
<div id="body8662426"><div class="section" id="EN-US_TOPIC_0000001854089205__en-us_topic_0000001594352977_section13730851154117"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000001854089205__en-us_topic_0000001594352977_p44733571019">This API is used to delete a VPN connection monitor with a specified ID.</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001854089205__en-us_topic_0000001594352977_section18104173342818"><h4 class="sectiontitle">Calling Method</h4><p id="EN-US_TOPIC_0000001854089205__en-us_topic_0000001594352977_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_0000001854089205__en-us_topic_0000001594352977_section127305519418"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0000001854089205__en-us_topic_0000001594352977_p169851426125712">DELETE /v5/{project_id}/connection-monitors/{connection_monitor_id}</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001854089205__en-us_topic_0000001594352977_table773085194114" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0000001854089205__en-us_topic_0000001594352977_row27311351104117"><th align="left" class="cellrowborder" valign="top" width="20.61793820617938%" id="mcps1.3.3.3.2.5.1.1"><p id="EN-US_TOPIC_0000001854089205__en-us_topic_0000001594352977_p67312517412">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_0000001854089205__en-us_topic_0000001594352977_p15731125134111">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_0000001854089205__en-us_topic_0000001594352977_p87311451154116">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_0000001854089205__en-us_topic_0000001594352977_p573165104117">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001854089205__en-us_topic_0000001594352977_row3731205113416"><td class="cellrowborder" valign="top" width="20.61793820617938%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001854089205__en-us_topic_0000001594352977_p1173165116415">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_0000001854089205__en-us_topic_0000001594352977_p1773175184119">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_0000001854089205__en-us_topic_0000001594352977_p7731145184110">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_0000001854089205__en-us_topic_0000001594352977_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_0000001854089205__en-us_topic_0000001594352977_row0695185632318"><td class="cellrowborder" valign="top" width="20.61793820617938%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001854089205__en-us_topic_0000001594352977_p192213594318">connection_monitor_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_0000001854089205__en-us_topic_0000001594352977_p16221359436">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_0000001854089205__en-us_topic_0000001594352977_p8221195915310">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_0000001854089205__en-us_topic_0000001594352977_p522115917311">Specifies the ID of a VPN connection monitor.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001854089205__en-us_topic_0000001594352977_section11731175194117"><h4 class="sectiontitle">Request</h4><ul id="EN-US_TOPIC_0000001854089205__en-us_topic_0000001594352977_ul17731451164113"><li id="EN-US_TOPIC_0000001854089205__en-us_topic_0000001594352977_li178241651181414">Request parameters<p id="EN-US_TOPIC_0000001854089205__en-us_topic_0000001594352977_p76495211415"><a name="EN-US_TOPIC_0000001854089205__en-us_topic_0000001594352977_li178241651181414"></a><a name="en-us_topic_0000001594352977_li178241651181414"></a>None</p>
</li><li id="EN-US_TOPIC_0000001854089205__en-us_topic_0000001594352977_li166714288208">Example request<pre class="screen" id="EN-US_TOPIC_0000001854089205__en-us_topic_0000001594352977_screen14731151194118">DELETE https://{Endpoint}/v5/{project_id}/connection-monitors/{connection_monitor_id}</pre>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0000001854089205__en-us_topic_0000001594352977_section1673185184120"><h4 class="sectiontitle">Response</h4><ul id="EN-US_TOPIC_0000001854089205__en-us_topic_0000001594352977_ul6742124163720"><li id="EN-US_TOPIC_0000001854089205__en-us_topic_0000001594352977_li13742164111371">Response parameters<p id="EN-US_TOPIC_0000001854089205__en-us_topic_0000001594352977_p97421641113715"><a name="EN-US_TOPIC_0000001854089205__en-us_topic_0000001594352977_li13742164111371"></a><a name="en-us_topic_0000001594352977_li13742164111371"></a>Returned status code 204: successful deletion</p>
</li><li id="EN-US_TOPIC_0000001854089205__en-us_topic_0000001594352977_li2742104183717">Example response<p id="EN-US_TOPIC_0000001854089205__en-us_topic_0000001594352977_p6742134113716"><a name="EN-US_TOPIC_0000001854089205__en-us_topic_0000001594352977_li2742104183717"></a><a name="en-us_topic_0000001594352977_li2742104183717"></a>None</p>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0000001854089205__en-us_topic_0000001594352977_section11731851174115"><h4 class="sectiontitle">Status Codes</h4><p id="EN-US_TOPIC_0000001854089205__en-us_topic_0000001594352977_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_0032.html">VPN Connection Monitoring</a></div>
</div>
</div>