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

226 lines
17 KiB
HTML
Raw Blame History

<a name="BatchDeleteServiceItems"></a><a name="BatchDeleteServiceItems"></a>
<h1 class="topictitle1">Deleting Service Group Members in Batches</h1>
<div id="body1708331107508"><div class="section" id="BatchDeleteServiceItems__section16645111512319"><h4 class="sectiontitle">Function</h4><p id="BatchDeleteServiceItems__p1464531583114">This API is used to delete service group members in batches.</p>
</div>
<div class="section" id="BatchDeleteServiceItems__section664511553118"><h4 class="sectiontitle">URI</h4><p id="BatchDeleteServiceItems__p18645615193111">DELETE /v1/{project_id}/service-items</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="BatchDeleteServiceItems__table96462015113113" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="BatchDeleteServiceItems__row76461815173117"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="BatchDeleteServiceItems__p126469151312">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="BatchDeleteServiceItems__p46461415113119">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="BatchDeleteServiceItems__p1764681593115">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="BatchDeleteServiceItems__p56471515103115">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="BatchDeleteServiceItems__row136468151315"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="BatchDeleteServiceItems__p1964717157315">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="BatchDeleteServiceItems__p664717158314">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="BatchDeleteServiceItems__p1064721523114">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="BatchDeleteServiceItems__p11647615153113">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="BatchDeleteServiceItems__table1464861563112" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query Parameters</caption><thead align="left"><tr id="BatchDeleteServiceItems__row364812151316"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.1"><p id="BatchDeleteServiceItems__p176481015123117">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.2"><p id="BatchDeleteServiceItems__p1164813150311">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.3"><p id="BatchDeleteServiceItems__p364819150314">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.4.2.5.1.4"><p id="BatchDeleteServiceItems__p1164911583119">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="BatchDeleteServiceItems__row106481715133110"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="BatchDeleteServiceItems__p76491215193115">enterprise_project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="BatchDeleteServiceItems__p17649171515316">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="BatchDeleteServiceItems__p964981519316">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="BatchDeleteServiceItems__p18649915183119">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="BatchDeleteServiceItems__b264961510317">0</strong>.</p>
</td>
</tr>
<tr id="BatchDeleteServiceItems__row164871543117"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="BatchDeleteServiceItems__p17650141517310">fw_instance_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="BatchDeleteServiceItems__p186501815173114">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="BatchDeleteServiceItems__p5650415143118">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="BatchDeleteServiceItems__p36501315133114">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="BatchDeleteServiceItems__section1665081515317"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="BatchDeleteServiceItems__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request header parameters</caption><thead align="left"><tr id="BatchDeleteServiceItems__row16650151533120"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="BatchDeleteServiceItems__p19651191513316">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="BatchDeleteServiceItems__p1465101503116">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="BatchDeleteServiceItems__p16511515113116">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="BatchDeleteServiceItems__p2651201513117">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="BatchDeleteServiceItems__row4651141513315"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="BatchDeleteServiceItems__p1665220151317">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="BatchDeleteServiceItems__p1965216152313">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="BatchDeleteServiceItems__p19652215143114">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="BatchDeleteServiceItems__p365261543116">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="BatchDeleteServiceItems__row15554733133117"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="BatchDeleteServiceItems__p16987185572214">Content-Type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="BatchDeleteServiceItems__p1453216872313">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="BatchDeleteServiceItems__p598785514223">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="BatchDeleteServiceItems__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="BatchDeleteServiceItems__request_DeleteServiceItemDto" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Request body parameters</caption><thead align="left"><tr id="BatchDeleteServiceItems__row1652161523115"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="BatchDeleteServiceItems__p1065341593112">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="BatchDeleteServiceItems__p1865331593117">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="BatchDeleteServiceItems__p106531315153112">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.2.5.1.4"><p id="BatchDeleteServiceItems__p18653315143119">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="BatchDeleteServiceItems__row156521615203117"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="BatchDeleteServiceItems__p165431513118">set_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="BatchDeleteServiceItems__p5654151516313">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="BatchDeleteServiceItems__p15654715123112">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="BatchDeleteServiceItems__p5654315193110">Service group ID, which can be obtained by calling the <a href="ListServiceSets.html">API for querying the service group list</a>. Find the value in <strong id="BatchDeleteServiceItems__b3654151511314">data.records.set_id</strong> (The period [.] is used to separate different levels of objects).</p>
</td>
</tr>
<tr id="BatchDeleteServiceItems__row5652715163115"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="BatchDeleteServiceItems__p1654815133117">service_item_ids</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="BatchDeleteServiceItems__p56541515183116">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="BatchDeleteServiceItems__p1655151517315">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="BatchDeleteServiceItems__p065511159318">List of service group member IDs. Service group member IDs can be obtained by calling the <a href="ListServiceItems.html">API for querying the service group member list</a>. Find the value in <strong id="BatchDeleteServiceItems__b166551715143119">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="BatchDeleteServiceItems__section365551563115"><h4 class="sectiontitle">Response Parameters</h4><p id="BatchDeleteServiceItems__p96551915143111"><strong id="BatchDeleteServiceItems__b12655215113118">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="BatchDeleteServiceItems__response_BatchDeleteServiceItemResponseBody" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Response body parameters</caption><thead align="left"><tr id="BatchDeleteServiceItems__row2655141563115"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="BatchDeleteServiceItems__p1365610156318">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p id="BatchDeleteServiceItems__p26565157312">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.4.1.3"><p id="BatchDeleteServiceItems__p6656115163114">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="BatchDeleteServiceItems__row11656015173116"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="BatchDeleteServiceItems__p136568151315">data</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="BatchDeleteServiceItems__p4657161519312">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="BatchDeleteServiceItems__p1865721518313">ID list of the service group members to be deleted in batches.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="BatchDeleteServiceItems__p66571115173120"><strong id="BatchDeleteServiceItems__b26572015123117">Status code: 400</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="BatchDeleteServiceItems__response_ErrorRsp" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Response body parameters</caption><thead align="left"><tr id="BatchDeleteServiceItems__row1865701523119"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.1"><p id="BatchDeleteServiceItems__p965820150311">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.2"><p id="BatchDeleteServiceItems__p18658201543119">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.5.2.4.1.3"><p id="BatchDeleteServiceItems__p1665812159314">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="BatchDeleteServiceItems__row1165771583110"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="BatchDeleteServiceItems__p265831520317">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="BatchDeleteServiceItems__p13659121519318">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="BatchDeleteServiceItems__p66591615143115">Error code.</p>
</td>
</tr>
<tr id="BatchDeleteServiceItems__row865731512318"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="BatchDeleteServiceItems__p16659101511318">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="BatchDeleteServiceItems__p1865991518316">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="BatchDeleteServiceItems__p665981513118">Error description.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="BatchDeleteServiceItems__section17659101543113"><h4 class="sectiontitle">Example Requests</h4><p id="BatchDeleteServiceItems__p17660121573118">Delete service group member f837f7ae-22c9-449d-a99c-4be24533e243 from service group 688faf62-20fc-4ca6-b9f9-6fbc518df5ae in project 9d80d070b6d44942af73c9c3d38e0429.</p>
<pre class="screen" id="BatchDeleteServiceItems__screen196600157319">https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/service-items?fw_instance_id=7a004e79-0b8b-4679-ab20-267f3946e8ba&amp;enterprise_project_id=default
{
"set_id" : "688faf62-20fc-4ca6-b9f9-6fbc518df5ae",
"service_item_ids" : [ "f837f7ae-22c9-449d-a99c-4be24533e243" ]
}</pre>
</div>
<div class="section" id="BatchDeleteServiceItems__section9661121583115"><h4 class="sectiontitle">Example Responses</h4><p id="BatchDeleteServiceItems__p1466119154315"><strong id="BatchDeleteServiceItems__b8661615203115">Status code: 200</strong></p>
<p id="BatchDeleteServiceItems__p1966118152314">Return value for deleting service group members in batches.</p>
<pre class="screen" id="BatchDeleteServiceItems__screen20661141503111">{
"data" : [ "f837f7ae-22c9-449d-a99c-4be24533e243" ]
}</pre>
<p id="BatchDeleteServiceItems__p96611915143111"><strong id="BatchDeleteServiceItems__b166141543118">Status code: 400</strong></p>
<p id="BatchDeleteServiceItems__p566214152314">Bad Request</p>
<pre class="screen" id="BatchDeleteServiceItems__screen866221513318">{
"error_code" : "CFW.00200005",
"error_msg" : "Object not found."
}</pre>
</div>
<div class="section" id="BatchDeleteServiceItems__section2800201583112"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="BatchDeleteServiceItems__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="BatchDeleteServiceItems__row1068591513314"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="BatchDeleteServiceItems__p1980041515318">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="BatchDeleteServiceItems__p17800121510314">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="BatchDeleteServiceItems__row16685161516313"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="BatchDeleteServiceItems__p580021533114">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="BatchDeleteServiceItems__p480081563111">Return value for deleting service group members in batches.</p>
</td>
</tr>
<tr id="BatchDeleteServiceItems__row196853150318"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="BatchDeleteServiceItems__p58002150311">400</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="BatchDeleteServiceItems__p1780016150316">Bad Request</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="BatchDeleteServiceItems__section280071516315"><h4 class="sectiontitle">Error Codes</h4><p id="BatchDeleteServiceItems__p280081512315">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_300000005.html">Service Group Management</a></div>
</div>
</div>
View Git Blame Copy Permalink