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>
64 lines
6.7 KiB
HTML
64 lines
6.7 KiB
HTML
<a name="EN-US_TOPIC_0000001854169137"></a><a name="EN-US_TOPIC_0000001854169137"></a>
|
|
|
|
<h1 class="topictitle1">Deleting a VPN Gateway</h1>
|
|
<div id="body8662426"><div class="section" id="EN-US_TOPIC_0000001854169137__en-us_topic_0000001543354016_section20114008"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000001854169137__en-us_topic_0000001543354016_p1841332044818">This API is used to delete a VPN gateway with a specified gateway ID. </p>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001854169137__en-us_topic_0000001543354016_section18104173342818"><h4 class="sectiontitle">Calling Method</h4><p id="EN-US_TOPIC_0000001854169137__en-us_topic_0000001543354016_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_0000001854169137__en-us_topic_0000001543354016_section46808346"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0000001854169137__en-us_topic_0000001543354016_p11431089487">DELETE /v5/{project_id}/vpn-gateways/{vgw_id}</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001854169137__en-us_topic_0000001543354016_table3672032" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0000001854169137__en-us_topic_0000001543354016_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_0000001854169137__en-us_topic_0000001543354016_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_0000001854169137__en-us_topic_0000001543354016_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_0000001854169137__en-us_topic_0000001543354016_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_0000001854169137__en-us_topic_0000001543354016_p43154149">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000001854169137__en-us_topic_0000001543354016_row5825185"><td class="cellrowborder" valign="top" width="20.61793820617938%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001854169137__en-us_topic_0000001543354016_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_0000001854169137__en-us_topic_0000001543354016_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_0000001854169137__en-us_topic_0000001543354016_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_0000001854169137__en-us_topic_0000001543354016_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_0000001854169137__en-us_topic_0000001543354016_row17781103218502"><td class="cellrowborder" valign="top" width="20.61793820617938%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001854169137__en-us_topic_0000001543354016_p223432524916">vgw_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_0000001854169137__en-us_topic_0000001543354016_p1623512511491">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_0000001854169137__en-us_topic_0000001543354016_p323511254498">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_0000001854169137__en-us_topic_0000001543354016_p1323614252494">Specifies the ID of a VPN gateway instance.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001854169137__en-us_topic_0000001543354016_section18621933"><h4 class="sectiontitle">Request</h4><ul id="EN-US_TOPIC_0000001854169137__en-us_topic_0000001543354016_ul5992193374713"><li id="EN-US_TOPIC_0000001854169137__en-us_topic_0000001543354016_li698716221966">Request parameters<p id="EN-US_TOPIC_0000001854169137__en-us_topic_0000001543354016_p154371423262"><a name="EN-US_TOPIC_0000001854169137__en-us_topic_0000001543354016_li698716221966"></a><a name="en-us_topic_0000001543354016_li698716221966"></a>None</p>
|
|
</li><li id="EN-US_TOPIC_0000001854169137__en-us_topic_0000001543354016_li09561421125317">Example request<pre class="screen" id="EN-US_TOPIC_0000001854169137__en-us_topic_0000001543354016_screen1778465375316">DELETE https://{Endpoint}/v5/{project_id}/vpn-gateways/{vgw_id}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001854169137__en-us_topic_0000001543354016_section33379675"><h4 class="sectiontitle">Response</h4><ul id="EN-US_TOPIC_0000001854169137__en-us_topic_0000001543354016_ul64586242379"><li id="EN-US_TOPIC_0000001854169137__en-us_topic_0000001543354016_li18459152423711">Response parameters<p id="EN-US_TOPIC_0000001854169137__en-us_topic_0000001543354016_p13459202410379"><a name="EN-US_TOPIC_0000001854169137__en-us_topic_0000001543354016_li18459152423711"></a><a name="en-us_topic_0000001543354016_li18459152423711"></a>Returned status code 204: successful deletion</p>
|
|
</li><li id="EN-US_TOPIC_0000001854169137__en-us_topic_0000001543354016_li1445918240372">Example response<p id="EN-US_TOPIC_0000001854169137__en-us_topic_0000001543354016_p6989161231219"><a name="EN-US_TOPIC_0000001854169137__en-us_topic_0000001543354016_li1445918240372"></a><a name="en-us_topic_0000001543354016_li1445918240372"></a>Response returned when a VPN gateway being created fails to be deleted</p>
|
|
<pre class="screen" id="EN-US_TOPIC_0000001854169137__en-us_topic_0000001543354016_screen171345174264">{
|
|
"error_code":"VPN.0003",
|
|
"error_msg":"resource (type=GATEWAY, ID=ff9bdca6-demo-a8df-va86-e4bcc1ea52bc) is not ready, currently CREATING",
|
|
"request_id": "1d94a4e8-fdc2-7bfd-943e-19bfa9b234ac"
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001854169137__en-us_topic_0000001543354016_section31981619"><h4 class="sectiontitle">Status Codes</h4><p id="EN-US_TOPIC_0000001854169137__en-us_topic_0000001543354016_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_0013.html">VPN Gateway</a></div>
|
|
</div>
|
|
</div>
|
|
|