Files
doc-exports/docs/cfw/api-ref/DeleteFirewall.html
qiaoli 9776db0ee8 First version of the CFW API
Reviewed-by: Gladkov, Maksim <mgladkov@noreply.gitea.eco.tsi-dev.otc-service.com>
Co-authored-by: qiaoli <qiaoli@huawei.com>
Co-committed-by: qiaoli <qiaoli@huawei.com>
2025-01-21 07:59:01 +00:00

128 lines
8.8 KiB
HTML

<a name="DeleteFirewall"></a><a name="DeleteFirewall"></a>
<h1 class="topictitle1">Deleting a Firewall</h1>
<div id="body1708331107508"><div class="section" id="DeleteFirewall__section19973104192217"><h4 class="sectiontitle">Function</h4><p id="DeleteFirewall__p209741241182210">This API is used to delete a firewall. It takes effect only for pay-per-use firewalls.</p>
</div>
<div class="section" id="DeleteFirewall__section1497414414228"><h4 class="sectiontitle">URI</h4><p id="DeleteFirewall__p1997434117225">DELETE /v2/{project_id}/firewall/{resource_id}</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteFirewall__table99751241152213" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="DeleteFirewall__row6974134122211"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="DeleteFirewall__p29763419220">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="DeleteFirewall__p3976841182214">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="DeleteFirewall__p12976134112218">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="DeleteFirewall__p16976144112228">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="DeleteFirewall__row797534120229"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="DeleteFirewall__p79765412227">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="DeleteFirewall__p18976184112223">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="DeleteFirewall__p11976174113229">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="DeleteFirewall__p997724172211">Project ID, which can be obtained by calling an API or from the console. For details, see <a href="cfw_02_0015.html">Obtaining a Project ID</a>.</p>
</td>
</tr>
<tr id="DeleteFirewall__row18975041152210"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="DeleteFirewall__p1897712415226">resource_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="DeleteFirewall__p11977194172213">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="DeleteFirewall__p3977114112229">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="DeleteFirewall__p5977164110227">Firewall ID, which can be obtained by referring to <a href="cfw_02_0028.html">Obtaining a Firewall ID</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="DeleteFirewall__section39771041102211"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteFirewall__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="DeleteFirewall__row1697724119222"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="DeleteFirewall__p1797814411224">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="DeleteFirewall__p169781941132216">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="DeleteFirewall__p997816419227">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="DeleteFirewall__p149781941142219">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="DeleteFirewall__row159784417226"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="DeleteFirewall__p11978184122211">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="DeleteFirewall__p12978164112225">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="DeleteFirewall__p497814418226">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="DeleteFirewall__p097914113226">User token. You can obtain the token by referring to <a href="cfw_02_0029.html">Obtaining a User Token</a>.</p>
</td>
</tr>
<tr id="DeleteFirewall__row1637419172711"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="DeleteFirewall__p16987185572214">Content-Type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="DeleteFirewall__p1453216872313">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="DeleteFirewall__p598785514223">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="DeleteFirewall__p1821149193417">Content type. It can only be set to application/json.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="DeleteFirewall__section13979154132217"><h4 class="sectiontitle">Response Parameters</h4><p id="DeleteFirewall__p59791141152218"><strong id="DeleteFirewall__b697912411229">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteFirewall__response_HttpDeleteFirewallResponse" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response body parameters</caption><thead align="left"><tr id="DeleteFirewall__row109798419227"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="DeleteFirewall__p7979174113224">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p id="DeleteFirewall__p797920416225">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.4.1.3"><p id="DeleteFirewall__p1998094119220">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="DeleteFirewall__row8979114119222"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="DeleteFirewall__p12980241132214">data</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="DeleteFirewall__p1898064119228">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="DeleteFirewall__p1898074132219">ID of a firewall deletion task.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="DeleteFirewall__section179807411225"><h4 class="sectiontitle">Example Requests</h4><p id="DeleteFirewall__p2980134152215">Delete the pay-per-use firewall 08065281-860a-4c98-aeb5-82cf65c44c46 from project 06217ebc876e427a80a2c05d51264ab1.</p>
<pre class="screen" id="DeleteFirewall__screen9980124110221">https://{Endpoint}/v2/06217ebc876e427a80a2c05d51264ab1/firewall/08065281-860a-4c98-aeb5-82cf65c44c46</pre>
</div>
<div class="section" id="DeleteFirewall__section15980184182212"><h4 class="sectiontitle">Example Responses</h4><p id="DeleteFirewall__p1598014112217"><strong id="DeleteFirewall__b098011415227">Status code: 200</strong></p>
<p id="DeleteFirewall__p1980194115223">Return value for deleting a firewall.</p>
<pre class="screen" id="DeleteFirewall__screen1698044132219">{
"data" : "56884cd0-cf3c-4cb7-bbeb-59d8722a2671"
}</pre>
</div>
<div class="section" id="DeleteFirewall__section49886417220"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteFirewall__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="DeleteFirewall__row1998812415222"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="DeleteFirewall__p199891741182220">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="DeleteFirewall__p198913419228">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="DeleteFirewall__row1098914172213"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="DeleteFirewall__p189893418223">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="DeleteFirewall__p49892415229">Return value for deleting a firewall.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="DeleteFirewall__section6989184113222"><h4 class="sectiontitle">Error Codes</h4><p id="DeleteFirewall__p0989104162211">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_300000000.html">Firewall Management</a></div>
</div>
</div>