yexinru/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
Files
fix_python
doc-exports/docs/cfw/api-ref/BatchDeleteAclRules.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

241 lines
18 KiB
HTML
Raw Permalink Blame History

<a name="BatchDeleteAclRules"></a><a name="BatchDeleteAclRules"></a>
<h1 class="topictitle1">Deleting ACL Rules in Batches</h1>
<div id="body1708331107508"><div class="section" id="BatchDeleteAclRules__section1162964613280"><h4 class="sectiontitle">Function</h4><p id="BatchDeleteAclRules__p662964618285">This API is used to delete ACL rules in batches.</p>
</div>
<div class="section" id="BatchDeleteAclRules__section66301246182818"><h4 class="sectiontitle">URI</h4><p id="BatchDeleteAclRules__p1963016467284">DELETE /v1/{project_id}/acl-rule</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="BatchDeleteAclRules__table136316468284" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="BatchDeleteAclRules__row136319469285"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="BatchDeleteAclRules__p5631104618289">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="BatchDeleteAclRules__p163274622819">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="BatchDeleteAclRules__p166321146182817">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="BatchDeleteAclRules__p106321346192817">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="BatchDeleteAclRules__row1063119462281"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="BatchDeleteAclRules__p26331046182817">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="BatchDeleteAclRules__p1463315466281">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="BatchDeleteAclRules__p14633164672816">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="BatchDeleteAclRules__p1863334662813">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>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="BatchDeleteAclRules__table76341146142814" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query Parameters</caption><thead align="left"><tr id="BatchDeleteAclRules__row1634194622813"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.1"><p id="BatchDeleteAclRules__p1634194642816">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.2"><p id="BatchDeleteAclRules__p363534620285">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.3"><p id="BatchDeleteAclRules__p4635134682817">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.4.2.5.1.4"><p id="BatchDeleteAclRules__p063554612289">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="BatchDeleteAclRules__row1163444652810"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="BatchDeleteAclRules__p26368465282">enterprise_project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="BatchDeleteAclRules__p186361346112813">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="BatchDeleteAclRules__p18636346132816">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="BatchDeleteAclRules__p176361346112814">Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to <a href="cfw_02_0027.html">Obtaining an Enterprise Project ID</a>. If the enterprise project function is not enabled, the value is <strong id="BatchDeleteAclRules__b5637346102814">0</strong>.</p>
</td>
</tr>
<tr id="BatchDeleteAclRules__row763464692811"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="BatchDeleteAclRules__p963713463285">fw_instance_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="BatchDeleteAclRules__p86375464288">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="BatchDeleteAclRules__p10637104613283">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="BatchDeleteAclRules__p963810466285">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="BatchDeleteAclRules__section14638446162819"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="BatchDeleteAclRules__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request header parameters</caption><thead align="left"><tr id="BatchDeleteAclRules__row106385463285"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="BatchDeleteAclRules__p1963954619286">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="BatchDeleteAclRules__p7639104613280">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="BatchDeleteAclRules__p106391946202820">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="BatchDeleteAclRules__p76406463286">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="BatchDeleteAclRules__row166384468285"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="BatchDeleteAclRules__p2640174652811">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="BatchDeleteAclRules__p464074613289">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="BatchDeleteAclRules__p146409464288">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="BatchDeleteAclRules__p76417462288">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="BatchDeleteAclRules__row165651813293"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="BatchDeleteAclRules__p16987185572214">Content-Type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="BatchDeleteAclRules__p1453216872313">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="BatchDeleteAclRules__p598785514223">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="BatchDeleteAclRules__p1821149193417">Content type. It can only be set to application/json.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="BatchDeleteAclRules__request_DeleteRuleAclDto" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Request body parameters</caption><thead align="left"><tr id="BatchDeleteAclRules__row66415464289"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="BatchDeleteAclRules__p106429469280">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="BatchDeleteAclRules__p196421146102819">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="BatchDeleteAclRules__p116421546172810">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.2.5.1.4"><p id="BatchDeleteAclRules__p136423461285">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="BatchDeleteAclRules__row464113468289"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="BatchDeleteAclRules__p146439463289">object_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="BatchDeleteAclRules__p15643144616284">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="BatchDeleteAclRules__p2064310469282">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="BatchDeleteAclRules__p364464616284">Protected object ID, which is used to distinguish between Internet border protection and VPC border protection after a cloud firewall is created. You can obtain the ID by calling the <a href="ListFirewallDetail.html">API for querying firewall instances</a>. In the return value, find the ID in <strong id="BatchDeleteAclRules__b064444619289">data.records.protect_objects.object_id</strong> (The period [.] is used to separate different levels of objects). If the value of <strong id="BatchDeleteAclRules__b26446461282">type</strong> is <strong id="BatchDeleteAclRules__b1464484612818">0</strong>, the protected object ID belongs to the Internet border. If the value of <strong id="BatchDeleteAclRules__b464418463289">type</strong> is <strong id="BatchDeleteAclRules__b164484652815">1</strong>, the protected object ID belongs to the VPC border. You can obtain the value of <strong id="BatchDeleteAclRules__b1764464622811">type</strong> from <strong id="BatchDeleteAclRules__b5644134642816">data.records.protect_objects.type</strong> (The period [.] is used to separate different levels of objects).</p>
</td>
</tr>
<tr id="BatchDeleteAclRules__row56412468280"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="BatchDeleteAclRules__p1564484615289">rule_ids</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="BatchDeleteAclRules__p66451046122819">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="BatchDeleteAclRules__p156451246182813">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="BatchDeleteAclRules__p19645154610289">Rule ID list, which is the ID list transferred when rules are deleted in batches. Rule IDs can be obtained by calling the <a href="ListAclRules.html">API for querying protection rules</a>. Find the value in <strong id="BatchDeleteAclRules__b864515463283">data.records.rule_id</strong> (The period [.] is used to separate different levels of objects).</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="BatchDeleteAclRules__section10646194615287"><h4 class="sectiontitle">Response Parameters</h4><p id="BatchDeleteAclRules__p116462461285"><strong id="BatchDeleteAclRules__b14646346152818">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="BatchDeleteAclRules__response_BatchDeleteAclRulesResponseBody" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Response body parameters</caption><thead align="left"><tr id="BatchDeleteAclRules__row14646114632817"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="BatchDeleteAclRules__p206471846182812">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p id="BatchDeleteAclRules__p1464734619282">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.4.1.3"><p id="BatchDeleteAclRules__p26478461287">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="BatchDeleteAclRules__row764644632812"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="BatchDeleteAclRules__p76481146132812">data</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="BatchDeleteAclRules__p2648154642815"><a href="#BatchDeleteAclRules__response_BatchDeleteAclRulesResponseData">BatchDeleteAclRulesResponseData</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="BatchDeleteAclRules__p5649114619286">Returned data for deleting ACL rules in batches.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="BatchDeleteAclRules__response_BatchDeleteAclRulesResponseData"></a><a name="response_BatchDeleteAclRulesResponseData"></a><table cellpadding="4" cellspacing="0" summary="" id="BatchDeleteAclRules__response_BatchDeleteAclRulesResponseData" frame="border" border="1" rules="all"><caption><b>Table 6 </b>BatchDeleteAclRulesResponseData</caption><thead align="left"><tr id="BatchDeleteAclRules__row2064914464282"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p id="BatchDeleteAclRules__p14650346112811">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.2"><p id="BatchDeleteAclRules__p1865044618288">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.4.2.4.1.3"><p id="BatchDeleteAclRules__p1565014692819">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="BatchDeleteAclRules__row15649346202817"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="BatchDeleteAclRules__p26510465284">responseDatas</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="BatchDeleteAclRules__p166519466282">Array of <a href="#BatchDeleteAclRules__response_BatchDeleteRuleInfo">BatchDeleteRuleInfo</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="BatchDeleteAclRules__p66512465287">Data returned when rules are deleted in batches.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="BatchDeleteAclRules__response_BatchDeleteRuleInfo"></a><a name="response_BatchDeleteRuleInfo"></a><table cellpadding="4" cellspacing="0" summary="" id="BatchDeleteAclRules__response_BatchDeleteRuleInfo" frame="border" border="1" rules="all"><caption><b>Table 7 </b>BatchDeleteRuleInfo</caption><thead align="left"><tr id="BatchDeleteAclRules__row146525468287"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.1"><p id="BatchDeleteAclRules__p6652946152819">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.2"><p id="BatchDeleteAclRules__p26521246172810">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.5.2.4.1.3"><p id="BatchDeleteAclRules__p365312460285">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="BatchDeleteAclRules__row1765264615288"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="BatchDeleteAclRules__p166533461286">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="BatchDeleteAclRules__p19653194610287">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="BatchDeleteAclRules__p9653646182816">Names of the ACL rules to be deleted in batches.</p>
</td>
</tr>
<tr id="BatchDeleteAclRules__row1865215462289"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="BatchDeleteAclRules__p065454612281">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="BatchDeleteAclRules__p0654346122815">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="BatchDeleteAclRules__p9654184618281">IDs of the ACL rules to be deleted in batches.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="BatchDeleteAclRules__section15654144611286"><h4 class="sectiontitle">Example Requests</h4><p id="BatchDeleteAclRules__p13655174619281">Delete rules 0475c516-0e41-4caf-990b-0c504eebd73f and 8662868e-fe7e-4dfc-bfb1-ca4d73081ca6 from the protected object ae42418e-f077-41a0-9d3b-5b2f5ad9102b whose project ID is 9d80d070b6d44942af73c9c3d38e0429.</p>
<pre class="screen" id="BatchDeleteAclRules__screen106550461284">https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/acl-rule
{
"rule_ids" : [ "0475c516-0e41-4caf-990b-0c504eebd73f", "8662868e-fe7e-4dfc-bfb1-ca4d73081ca6" ],
"object_id" : "ae42418e-f077-41a0-9d3b-5b2f5ad9102b"
}</pre>
</div>
<div class="section" id="BatchDeleteAclRules__section4656184672812"><h4 class="sectiontitle">Example Responses</h4><p id="BatchDeleteAclRules__p19657746122820"><strong id="BatchDeleteAclRules__b16657124617284">Status code: 200</strong></p>
<p id="BatchDeleteAclRules__p6657846152818">Return value for deleting rules in batches.</p>
<pre class="screen" id="BatchDeleteAclRules__screen0657144612810">{
"data" : {
"responseDatas" : [ {
"name" : "test",
"id" : "0475c516-0e41-4caf-990b-0c504eebd73f"
}, {
"name" : "test2",
"id" : "8662868e-fe7e-4dfc-bfb1-ca4d73081ca6"
} ]
}
}</pre>
</div>
<div class="section" id="BatchDeleteAclRules__section14830124612281"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="BatchDeleteAclRules__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="BatchDeleteAclRules__row16687114610281"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="BatchDeleteAclRules__p128301646162811">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="BatchDeleteAclRules__p98301346152818">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="BatchDeleteAclRules__row96872046122811"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="BatchDeleteAclRules__p5830124622818">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="BatchDeleteAclRules__p15831154612815">Return value for deleting rules in batches.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="BatchDeleteAclRules__section5831124602813"><h4 class="sectiontitle">Error Codes</h4><p id="BatchDeleteAclRules__p7831194632815">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_300000002.html">ACL Rule Management</a></div>
</div>
</div>
View Git Blame Copy Permalink