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

188 lines
14 KiB
HTML
Raw Blame History

<a name="BatchDeleteAddressItems"></a><a name="BatchDeleteAddressItems"></a>
<h1 class="topictitle1">Deleting Address Group Members in Batches</h1>
<div id="body1708331107508"><div class="section" id="BatchDeleteAddressItems__section12843101919306"><h4 class="sectiontitle">Function</h4><p id="BatchDeleteAddressItems__p08431719203017">This API is used to delete address group members in batches.</p>
</div>
<div class="section" id="BatchDeleteAddressItems__section78441191305"><h4 class="sectiontitle">URI</h4><p id="BatchDeleteAddressItems__p58441819143013">DELETE /v1/{project_id}/address-items</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="BatchDeleteAddressItems__table88451619183016" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="BatchDeleteAddressItems__row20844419143011"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="BatchDeleteAddressItems__p148451819123010">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="BatchDeleteAddressItems__p784514191302">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="BatchDeleteAddressItems__p6845101914306">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="BatchDeleteAddressItems__p20846719163010">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="BatchDeleteAddressItems__row784401916301"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="BatchDeleteAddressItems__p9846151903010">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="BatchDeleteAddressItems__p188464196303">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="BatchDeleteAddressItems__p16846181912303">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="BatchDeleteAddressItems__p168461219143011">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="BatchDeleteAddressItems__table1884731915301" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query Parameters</caption><thead align="left"><tr id="BatchDeleteAddressItems__row68471219153014"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.1"><p id="BatchDeleteAddressItems__p08478196301">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.2"><p id="BatchDeleteAddressItems__p1584715199302">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.3"><p id="BatchDeleteAddressItems__p20848201983011">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.4.2.5.1.4"><p id="BatchDeleteAddressItems__p1984851953013">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="BatchDeleteAddressItems__row19847101973011"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="BatchDeleteAddressItems__p158481819103020">enterprise_project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="BatchDeleteAddressItems__p8848131903018">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="BatchDeleteAddressItems__p58481619133011">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="BatchDeleteAddressItems__p984931913308">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="BatchDeleteAddressItems__b12849819123013">0</strong>.</p>
</td>
</tr>
<tr id="BatchDeleteAddressItems__row384711191300"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="BatchDeleteAddressItems__p484913199303">fw_instance_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="BatchDeleteAddressItems__p1684991918309">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="BatchDeleteAddressItems__p184951919303">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="BatchDeleteAddressItems__p1684910198308">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="BatchDeleteAddressItems__section18501219193012"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="BatchDeleteAddressItems__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request header parameters</caption><thead align="left"><tr id="BatchDeleteAddressItems__row18850131918303"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="BatchDeleteAddressItems__p1185111953017">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="BatchDeleteAddressItems__p685161911309">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="BatchDeleteAddressItems__p1485111913307">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="BatchDeleteAddressItems__p985119198306">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="BatchDeleteAddressItems__row1585011963012"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="BatchDeleteAddressItems__p9851111919304">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="BatchDeleteAddressItems__p178529195307">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="BatchDeleteAddressItems__p585211973015">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="BatchDeleteAddressItems__p15852101923013">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="BatchDeleteAddressItems__row145512404300"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="BatchDeleteAddressItems__p16987185572214">Content-Type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="BatchDeleteAddressItems__p1453216872313">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="BatchDeleteAddressItems__p598785514223">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="BatchDeleteAddressItems__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="BatchDeleteAddressItems__request_DeleteAddressItemsInfoDto" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Request body parameters</caption><thead align="left"><tr id="BatchDeleteAddressItems__row5852219173019"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="BatchDeleteAddressItems__p148531919173018">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="BatchDeleteAddressItems__p1785311911303">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="BatchDeleteAddressItems__p17853819153013">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.2.5.1.4"><p id="BatchDeleteAddressItems__p19853619103015">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="BatchDeleteAddressItems__row6852419133014"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="BatchDeleteAddressItems__p1885316195303">set_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="BatchDeleteAddressItems__p14854191993017">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="BatchDeleteAddressItems__p885421973016">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="BatchDeleteAddressItems__p285413197303">Address group ID, which can be obtained by calling the <a href="ListAddressSets.html">API for querying the address group list</a>. Find the value in <strong id="BatchDeleteAddressItems__b585413192307">data.records.set_id</strong> (The period [.] is used to separate different levels of objects).</p>
</td>
</tr>
<tr id="BatchDeleteAddressItems__row985241963013"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="BatchDeleteAddressItems__p128545194307">address_item_ids</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="BatchDeleteAddressItems__p6855121918309">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="BatchDeleteAddressItems__p158554190302">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="BatchDeleteAddressItems__p17855151917303">List of address group member IDs. Address group member IDs can be obtained by calling the <a href="ListAddressItems.html">API for querying address group members</a>. Find the value in <strong id="BatchDeleteAddressItems__b13855171933020">data.records.item_id</strong> (The period [.] is used to separate different levels of objects).</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="BatchDeleteAddressItems__section3855819113012"><h4 class="sectiontitle">Response Parameters</h4><p id="BatchDeleteAddressItems__p1785591933016"><strong id="BatchDeleteAddressItems__b158551719133018">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="BatchDeleteAddressItems__response_BatchDeleteAddressItemsResponseBody" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Response body parameters</caption><thead align="left"><tr id="BatchDeleteAddressItems__row108561019113019"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="BatchDeleteAddressItems__p28561019133011">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p id="BatchDeleteAddressItems__p28561719103019">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.4.1.3"><p id="BatchDeleteAddressItems__p13856141933012">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="BatchDeleteAddressItems__row1285611914306"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="BatchDeleteAddressItems__p38571419183018">data</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="BatchDeleteAddressItems__p6857151983011">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="BatchDeleteAddressItems__p12857191933018">ID list of the address group members to be deleted in batches.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="BatchDeleteAddressItems__section19857519203016"><h4 class="sectiontitle">Example Requests</h4><p id="BatchDeleteAddressItems__p12857191933012">Delete address group member d072ad2e-033c-40a9-b0b5-751f9c2943a6 from address group e4884376-7efb-40e7-b98b-13668d6f8b85 in project 9d80d070b6d44942af73c9c3d38e0429.</p>
<pre class="screen" id="BatchDeleteAddressItems__screen17858191913306">https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/address-items?fw_instance_id=7a004e79-0b8b-4679-ab20-267f3946e8ba&amp;enterprise_project_id=default
{
"set_id" : "e4884376-7efb-40e7-b98b-13668d6f8b85",
"address_item_ids" : [ "d072ad2e-033c-40a9-b0b5-751f9c2943a6" ]
}</pre>
</div>
<div class="section" id="BatchDeleteAddressItems__section11859619163011"><h4 class="sectiontitle">Example Responses</h4><p id="BatchDeleteAddressItems__p1085921920303"><strong id="BatchDeleteAddressItems__b0859519103010">Status code: 200</strong></p>
<p id="BatchDeleteAddressItems__p1085941918303">Return value for deleting address group members in batches.</p>
<pre class="screen" id="BatchDeleteAddressItems__screen17859171933011">{
"data" : [ "d072ad2e-033c-40a9-b0b5-751f9c2943a6" ]
}</pre>
</div>
<div class="section" id="BatchDeleteAddressItems__section1116209306"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="BatchDeleteAddressItems__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="BatchDeleteAddressItems__row108841219143014"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="BatchDeleteAddressItems__p21122018302">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="BatchDeleteAddressItems__p201122023012">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="BatchDeleteAddressItems__row1488416194301"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="BatchDeleteAddressItems__p9118208304">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="BatchDeleteAddressItems__p111152073019">Return value for deleting address group members in batches.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="BatchDeleteAddressItems__section31920143016"><h4 class="sectiontitle">Error Codes</h4><p id="BatchDeleteAddressItems__p1821120123013">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_300000004.html">Address Group Management</a></div>
</div>
</div>
View Git Blame Copy Permalink