1
0
forked from docs/doc-exports
doc-exports/docs/dc/api-ref/DeleteVirtualGateway.html
Qin Ying, Fan 62ab8a5fe2 DC API 20231101 version
Reviewed-by: Sarda, Priya <prsarda@noreply.gitea.eco.tsi-dev.otc-service.com>
Co-authored-by: Qin Ying, Fan <fanqinying@huawei.com>
Co-committed-by: Qin Ying, Fan <fanqinying@huawei.com>
2024-03-11 15:10:40 +00:00

98 lines
8.7 KiB
HTML

<a name="DeleteVirtualGateway"></a><a name="DeleteVirtualGateway"></a>
<h1 class="topictitle1">Deleting a Virtual Gateway</h1>
<div id="body8662426"><div class="section" id="DeleteVirtualGateway__en-us_topic_0000001782705609_section3212213111713"><h4 class="sectiontitle">Function</h4><p id="DeleteVirtualGateway__en-us_topic_0000001782705609_p221215131175">The API is used to delete a specified virtual gateway.</p>
</div>
<div class="section" id="DeleteVirtualGateway__en-us_topic_0000001782705609_section4213171351717"><h4 class="sectiontitle">URI</h4><p id="DeleteVirtualGateway__en-us_topic_0000001782705609_p821318130178">DELETE /v3/{project_id}/dcaas/virtual-gateways/{virtual_gateway_id}</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteVirtualGateway__en-us_topic_0000001782705609_table162141138177" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="DeleteVirtualGateway__en-us_topic_0000001782705609_row4214181312172"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="DeleteVirtualGateway__en-us_topic_0000001782705609_p1021511371713">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="DeleteVirtualGateway__en-us_topic_0000001782705609_p921551371713">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="DeleteVirtualGateway__en-us_topic_0000001782705609_p92151313191716">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="DeleteVirtualGateway__en-us_topic_0000001782705609_p22161713151715">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="DeleteVirtualGateway__en-us_topic_0000001782705609_row1721461341717"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="DeleteVirtualGateway__en-us_topic_0000001782705609_p1721681310171">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="DeleteVirtualGateway__en-us_topic_0000001782705609_p4216413151716">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="DeleteVirtualGateway__en-us_topic_0000001782705609_p17216113201714">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="DeleteVirtualGateway__en-us_topic_0000001782705609_p14217101321715">Specifies the project ID.</p>
</td>
</tr>
<tr id="DeleteVirtualGateway__en-us_topic_0000001782705609_row72141413101714"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="DeleteVirtualGateway__en-us_topic_0000001782705609_p52170139171">virtual_gateway_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="DeleteVirtualGateway__en-us_topic_0000001782705609_p22172013151712">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="DeleteVirtualGateway__en-us_topic_0000001782705609_p92171713141711">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="DeleteVirtualGateway__en-us_topic_0000001782705609_p1021811316174">Specifies the virtual gateway ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="DeleteVirtualGateway__en-us_topic_0000001782705609_section112181413111717"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteVirtualGateway__en-us_topic_0000001782705609_HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="DeleteVirtualGateway__en-us_topic_0000001782705609_row4218813121716"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="DeleteVirtualGateway__en-us_topic_0000001782705609_p192195133177">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="DeleteVirtualGateway__en-us_topic_0000001782705609_p9220171311175">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="DeleteVirtualGateway__en-us_topic_0000001782705609_p722012134171">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="DeleteVirtualGateway__en-us_topic_0000001782705609_p1722018139170">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="DeleteVirtualGateway__en-us_topic_0000001782705609_row9219121313172"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="DeleteVirtualGateway__en-us_topic_0000001782705609_p222012135177">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="DeleteVirtualGateway__en-us_topic_0000001782705609_p7221513131716">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="DeleteVirtualGateway__en-us_topic_0000001782705609_p322141321720">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="DeleteVirtualGateway__en-us_topic_0000001782705609_p42211113191713">Specifies the user token. To obtain the token, see section "Obtaining the User Token" in the <em id="DeleteVirtualGateway__en-us_topic_0000001782705609_i192218137173">Identity and Access Management API Reference</em>. The token is the value of <strong id="DeleteVirtualGateway__en-us_topic_0000001782705609_b102211213131710">X-Subject-Token</strong> in the response header.</p>
<p id="DeleteVirtualGateway__en-us_topic_0000001782705609_p112211513181716">Minimum: <strong id="DeleteVirtualGateway__en-us_topic_0000001782705609_b18221513121717">0</strong></p>
<p id="DeleteVirtualGateway__en-us_topic_0000001782705609_p422213137173">Maximum: <strong id="DeleteVirtualGateway__en-us_topic_0000001782705609_b4222101341713">10240</strong></p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="DeleteVirtualGateway__en-us_topic_0000001782705609_section82220133172"><h4 class="sectiontitle">Response Parameters</h4><p id="DeleteVirtualGateway__en-us_topic_0000001782705609_p12222813161711">None</p>
</div>
<div class="section" id="DeleteVirtualGateway__en-us_topic_0000001782705609_section422211132179"><h4 class="sectiontitle">Example Requests</h4><p id="DeleteVirtualGateway__en-us_topic_0000001782705609_p3222121381720">Deleting a virtual gateway</p>
<pre class="screen" id="DeleteVirtualGateway__en-us_topic_0000001782705609_screen152235137174">DELETE https://{dc_endpoint}/v3/08d5a9564a704afda6039ae2babbef3c/dcaas/virtual-gateways/20082c1b-3c99-48d8-8e8c-116af5d7e9f0</pre>
</div>
<div class="section" id="DeleteVirtualGateway__en-us_topic_0000001782705609_section102231013101710"><h4 class="sectiontitle">Example Responses</h4><p id="DeleteVirtualGateway__en-us_topic_0000001782705609_p16223813201712">None</p>
</div>
<div class="section" id="DeleteVirtualGateway__en-us_topic_0000001782705609_section132401513121711"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteVirtualGateway__en-us_topic_0000001782705609_status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="DeleteVirtualGateway__en-us_topic_0000001782705609_row1724119131172"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="DeleteVirtualGateway__en-us_topic_0000001782705609_p0241413201720">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="DeleteVirtualGateway__en-us_topic_0000001782705609_p15242141316178">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="DeleteVirtualGateway__en-us_topic_0000001782705609_row152415134170"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="DeleteVirtualGateway__en-us_topic_0000001782705609_p3242813101714">204</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="DeleteVirtualGateway__en-us_topic_0000001782705609_p11242141371718">No Content</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="DeleteVirtualGateway__en-us_topic_0000001782705609_section1524211310171"><h4 class="sectiontitle">Error Codes</h4><p id="DeleteVirtualGateway__en-us_topic_0000001782705609_p124371341716">See <a href="ErrorCode.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000001.html">Virtual Gateway</a></div>
</div>
</div>