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/DeleteServiceItem.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

247 lines
18 KiB
HTML
Raw Permalink Blame History

<a name="DeleteServiceItem"></a><a name="DeleteServiceItem"></a>
<h1 class="topictitle1">Deleting a Service Group Member</h1>
<div id="body1708331107508"><div class="section" id="DeleteServiceItem__section151417105314"><h4 class="sectiontitle">Function</h4><p id="DeleteServiceItem__p181541016311">This API is used to delete a member from a service group.</p>
</div>
<div class="section" id="DeleteServiceItem__section617110183115"><h4 class="sectiontitle">URI</h4><p id="DeleteServiceItem__p61781019319">DELETE /v1/{project_id}/service-items/{item_id}</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteServiceItem__table20191810193116" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="DeleteServiceItem__row191871093116"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="DeleteServiceItem__p1919201011315">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="DeleteServiceItem__p02011018311">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="DeleteServiceItem__p16201310183115">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="DeleteServiceItem__p521510133120">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="DeleteServiceItem__row41881018316"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="DeleteServiceItem__p521111013318">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="DeleteServiceItem__p522191043112">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="DeleteServiceItem__p14221410113113">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="DeleteServiceItem__p182314105316">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="DeleteServiceItem__row2181010113118"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="DeleteServiceItem__p13241010133112">item_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="DeleteServiceItem__p7240105312">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="DeleteServiceItem__p5251810163116">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="DeleteServiceItem__p7268100318">Service group member ID, which 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="DeleteServiceItem__b17261310173114">data.records.item_id</strong> (The period [.] is used to separate different levels of objects).</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteServiceItem__table827151020310" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query Parameters</caption><thead align="left"><tr id="DeleteServiceItem__row17261910163112"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.1"><p id="DeleteServiceItem__p15271310113110">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.2"><p id="DeleteServiceItem__p17281710133114">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.3"><p id="DeleteServiceItem__p329510193111">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.4.2.5.1.4"><p id="DeleteServiceItem__p1929201015318">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="DeleteServiceItem__row11261106313"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="DeleteServiceItem__p1430181020319">enterprise_project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="DeleteServiceItem__p43081017319">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="DeleteServiceItem__p031171012312">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="DeleteServiceItem__p23291019318">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="DeleteServiceItem__b1932191073115">0</strong>.</p>
</td>
</tr>
<tr id="DeleteServiceItem__row1326111018318"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="DeleteServiceItem__p133201012311">fw_instance_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="DeleteServiceItem__p83381012316">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="DeleteServiceItem__p433141016312">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="DeleteServiceItem__p634171015316">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="DeleteServiceItem__section10350101318"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteServiceItem__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request header parameters</caption><thead align="left"><tr id="DeleteServiceItem__row133591011317"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="DeleteServiceItem__p1371310183112">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="DeleteServiceItem__p203761093114">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="DeleteServiceItem__p438181023111">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="DeleteServiceItem__p133871014316">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="DeleteServiceItem__row3358105311"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="DeleteServiceItem__p1639111093113">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="DeleteServiceItem__p1139101019311">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="DeleteServiceItem__p9408101316">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="DeleteServiceItem__p12411710183115">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="DeleteServiceItem__row1871112963114"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="DeleteServiceItem__p16987185572214">Content-Type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="DeleteServiceItem__p1453216872313">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="DeleteServiceItem__p598785514223">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="DeleteServiceItem__p1821149193417">Content type. It can only be set to application/json.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="DeleteServiceItem__section19421310173112"><h4 class="sectiontitle">Response Parameters</h4><p id="DeleteServiceItem__p104219100315"><strong id="DeleteServiceItem__b15421210133111">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteServiceItem__response_DeleteServiceItemResponseBody" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameters</caption><thead align="left"><tr id="DeleteServiceItem__row843210103113"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="DeleteServiceItem__p17441210113118">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p id="DeleteServiceItem__p1944141012317">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.4.1.3"><p id="DeleteServiceItem__p174571017311">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="DeleteServiceItem__row44316108316"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="DeleteServiceItem__p134520106311">data</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="DeleteServiceItem__p204618103313"><a href="#DeleteServiceItem__response_DeleteServiceItemResponseBodyData">DeleteServiceItemResponseBodyData</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="DeleteServiceItem__p44715102318">Delete service group member data.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="DeleteServiceItem__response_DeleteServiceItemResponseBodyData"></a><a name="response_DeleteServiceItemResponseBodyData"></a><table cellpadding="4" cellspacing="0" summary="" id="DeleteServiceItem__response_DeleteServiceItemResponseBodyData" frame="border" border="1" rules="all"><caption><b>Table 5 </b>DeleteServiceItemResponseBodyData</caption><thead align="left"><tr id="DeleteServiceItem__row547710113112"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p id="DeleteServiceItem__p34816102313">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.2"><p id="DeleteServiceItem__p34914103310">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.4.2.4.1.3"><p id="DeleteServiceItem__p5490106312">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="DeleteServiceItem__row1247151073114"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="DeleteServiceItem__p175031073116">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="DeleteServiceItem__p05031019318">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="DeleteServiceItem__p16518102314">Service group member ID.</p>
</td>
</tr>
<tr id="DeleteServiceItem__row13471410123110"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="DeleteServiceItem__p051161063110">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="DeleteServiceItem__p552710163113">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="DeleteServiceItem__p952121043112">Service group member name.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="DeleteServiceItem__p35391053112"><strong id="DeleteServiceItem__b105311104316">Status code: 400</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteServiceItem__response_ErrorRsp" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Response body parameters</caption><thead align="left"><tr id="DeleteServiceItem__row15391010312"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.4.1.1"><p id="DeleteServiceItem__p185471063118">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.4.1.2"><p id="DeleteServiceItem__p4557102311">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.6.2.4.1.3"><p id="DeleteServiceItem__p1356141019312">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="DeleteServiceItem__row2531410113112"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="DeleteServiceItem__p756710113115">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="DeleteServiceItem__p55715101319">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="DeleteServiceItem__p257111033113">Error code.</p>
</td>
</tr>
<tr id="DeleteServiceItem__row05421017317"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="DeleteServiceItem__p12587106310">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="DeleteServiceItem__p1358110193119">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="DeleteServiceItem__p20591310113118">Error description.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="DeleteServiceItem__section5591910173113"><h4 class="sectiontitle">Example Requests</h4><p id="DeleteServiceItem__p960131013117">Delete the service group member whose ID is 6b37ed55-1e21-46a5-a7dc-a59ef418d359 from project 9d80d070b6d44942af73c9c3d38e0429.</p>
<pre class="screen" id="DeleteServiceItem__screen1960110173118">https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/service-items/6b37ed55-1e21-46a5-a7dc-a59ef418d359</pre>
</div>
<div class="section" id="DeleteServiceItem__section18621810113110"><h4 class="sectiontitle">Example Responses</h4><p id="DeleteServiceItem__p116210108314"><strong id="DeleteServiceItem__b16291073112">Status code: 200</strong></p>
<p id="DeleteServiceItem__p1663310183120">Information returned for service group member deletion.</p>
<pre class="screen" id="DeleteServiceItem__screen11641610193114">{
"data" : {
"id" : "26f562c4-fe11-43d0-9654-f54298d5b12e",
"name" : "0|1"
}
}</pre>
<p id="DeleteServiceItem__p1366131053111"><strong id="DeleteServiceItem__b966910203116">Status code: 400</strong></p>
<p id="DeleteServiceItem__p12661010173119">Bad Request</p>
<pre class="screen" id="DeleteServiceItem__screen76891013120">{
"error_code" : "CFW.0020016",
"error_msg" : "Incorrect instance status."
}</pre>
</div>
<div class="section" id="DeleteServiceItem__section63441910103112"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteServiceItem__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="DeleteServiceItem__row61300104317"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="DeleteServiceItem__p11345810193116">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="DeleteServiceItem__p13451010103111">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="DeleteServiceItem__row1613015108313"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="DeleteServiceItem__p173451510173115">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="DeleteServiceItem__p1334631017312">Information returned for service group member deletion.</p>
</td>
</tr>
<tr id="DeleteServiceItem__row913061014313"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="DeleteServiceItem__p434661013317">400</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="DeleteServiceItem__p93461610123120">Bad Request</p>
</td>
</tr>
<tr id="DeleteServiceItem__row1113031063113"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="DeleteServiceItem__p5346201013113">401</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="DeleteServiceItem__p63471107314">Unauthorized</p>
</td>
</tr>
<tr id="DeleteServiceItem__row1413031043113"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="DeleteServiceItem__p103478107313">403</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="DeleteServiceItem__p5347111013118">Forbidden</p>
</td>
</tr>
<tr id="DeleteServiceItem__row5130161012313"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="DeleteServiceItem__p193471410163112">404</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="DeleteServiceItem__p183481910133118">Not Found</p>
</td>
</tr>
<tr id="DeleteServiceItem__row9130131013311"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="DeleteServiceItem__p1334815109311">500</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="DeleteServiceItem__p1734820109312">Internal Server Error</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="DeleteServiceItem__section143481910103119"><h4 class="sectiontitle">Error Codes</h4><p id="DeleteServiceItem__p83491710183119">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