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>
65 lines
6.9 KiB
HTML
65 lines
6.9 KiB
HTML
<a name="EN-US_TOPIC_0000001807530296"></a><a name="EN-US_TOPIC_0000001807530296"></a>
|
|
|
|
<h1 class="topictitle1">Deleting a Customer Gateway</h1>
|
|
<div id="body8662426"><div class="section" id="EN-US_TOPIC_0000001807530296__en-us_topic_0000001543833176_section20114008"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000001807530296__en-us_topic_0000001543833176_p17560192314117">This API is used to delete a customer gateway with a specified gateway ID.</p>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001807530296__en-us_topic_0000001543833176_section18104173342818"><h4 class="sectiontitle">Calling Method</h4><p id="EN-US_TOPIC_0000001807530296__en-us_topic_0000001543833176_p746204214324">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_0000001807530296__en-us_topic_0000001543833176_section46808346"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0000001807530296__en-us_topic_0000001543833176_p13331432202014">DELETE /v5/{project_id}/customer-gateways/{customer_gateway_id}</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001807530296__en-us_topic_0000001543833176_table92218" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0000001807530296__en-us_topic_0000001543833176_row18318257283"><th align="left" class="cellrowborder" valign="top" width="19.607843137254903%" id="mcps1.3.3.3.2.5.1.1"><p id="EN-US_TOPIC_0000001807530296__en-us_topic_0000001543833176_p1183122515280">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="19.607843137254903%" id="mcps1.3.3.3.2.5.1.2"><p id="EN-US_TOPIC_0000001807530296__en-us_topic_0000001543833176_p383162513282">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="11.76470588235294%" id="mcps1.3.3.3.2.5.1.3"><p id="EN-US_TOPIC_0000001807530296__en-us_topic_0000001543833176_p08321425102812">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="49.01960784313725%" id="mcps1.3.3.3.2.5.1.4"><p id="EN-US_TOPIC_0000001807530296__en-us_topic_0000001543833176_p8832162510286">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000001807530296__en-us_topic_0000001543833176_row11831172515283"><td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001807530296__en-us_topic_0000001543833176_p16832202514282">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001807530296__en-us_topic_0000001543833176_p15832192572819">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.76470588235294%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001807530296__en-us_topic_0000001543833176_p17832192510287">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.01960784313725%" headers="mcps1.3.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001807530296__en-us_topic_0000001543833176_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_0000001807530296__en-us_topic_0000001543833176_row12831162522818"><td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001807530296__en-us_topic_0000001543833176_p6832122582814">customer_gateway_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001807530296__en-us_topic_0000001543833176_p1383282519289">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.76470588235294%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001807530296__en-us_topic_0000001543833176_p188331525202810">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.01960784313725%" headers="mcps1.3.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001807530296__en-us_topic_0000001543833176_p12833102522812">Specifies a customer gateway ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001807530296__en-us_topic_0000001543833176_section18621933"><h4 class="sectiontitle">Request</h4><ul id="EN-US_TOPIC_0000001807530296__en-us_topic_0000001543833176_ul5992193374713"><li id="EN-US_TOPIC_0000001807530296__en-us_topic_0000001543833176_li6664412111315">Request parameters<p id="EN-US_TOPIC_0000001807530296__en-us_topic_0000001543833176_p791013131311"><a name="EN-US_TOPIC_0000001807530296__en-us_topic_0000001543833176_li6664412111315"></a><a name="en-us_topic_0000001543833176_li6664412111315"></a>None</p>
|
|
</li><li id="EN-US_TOPIC_0000001807530296__en-us_topic_0000001543833176_li47809585811">Example request<pre class="screen" id="EN-US_TOPIC_0000001807530296__en-us_topic_0000001543833176_screen1778465375316">DELETE https://{Endpoint}/v5/{project_id}/customer-gateways/{customer_gateway_id}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001807530296__en-us_topic_0000001543833176_section33379675"><h4 class="sectiontitle">Response</h4><ul id="EN-US_TOPIC_0000001807530296__en-us_topic_0000001543833176_ul1314793119379"><li id="EN-US_TOPIC_0000001807530296__en-us_topic_0000001543833176_li6147153183715">Response parameters<p id="EN-US_TOPIC_0000001807530296__en-us_topic_0000001543833176_p161472031173718"><a name="EN-US_TOPIC_0000001807530296__en-us_topic_0000001543833176_li6147153183715"></a><a name="en-us_topic_0000001543833176_li6147153183715"></a>Returned status code 204: successful deletion</p>
|
|
</li><li id="EN-US_TOPIC_0000001807530296__en-us_topic_0000001543833176_li1714810316375">Example response<div class="p" id="EN-US_TOPIC_0000001807530296__en-us_topic_0000001543833176_p1614883173715"><a name="EN-US_TOPIC_0000001807530296__en-us_topic_0000001543833176_li1714810316375"></a><a name="en-us_topic_0000001543833176_li1714810316375"></a>Response returned when a customer gateway that has been created and has VPN connections fails to be deleted<pre class="screen" id="EN-US_TOPIC_0000001807530296__en-us_topic_0000001543833176_screen1118810229282">DELETE https://{Endpoint}/v5/{project_id}/customer-gateways/{customer_gateway_id}
|
|
{
|
|
"error_code": "VPN.0001",
|
|
"error_msg": "invalid request: customer gateway 575c1722-demo-a8df-va86-dd7f41876332 has connection",
|
|
"request_id": "c923ac44-1890-48d5-a004-5be6432cf361"
|
|
}</pre>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001807530296__en-us_topic_0000001543833176_section31981619"><h4 class="sectiontitle">Status Codes</h4><p id="EN-US_TOPIC_0000001807530296__en-us_topic_0000001543833176_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_0020.html">Customer Gateway</a></div>
|
|
</div>
|
|
</div>
|
|
|