yexinru/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
Files
9776db0ee8a683d760113bf6d389063073121b5d
doc-exports/docs/cfw/api-ref/DeleteServiceSet.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
17 KiB
HTML
Raw Blame History

<a name="DeleteServiceSet"></a><a name="DeleteServiceSet"></a>
<h1 class="topictitle1">Deleting a Service Group</h1>
<div id="body1708331107508"><div class="section" id="DeleteServiceSet__section191852010103110"><h4 class="sectiontitle">Function</h4><p id="DeleteServiceSet__p5185111020317">This API is used to delete a service group.</p>
</div>
<div class="section" id="DeleteServiceSet__section15187141023116"><h4 class="sectiontitle">URI</h4><p id="DeleteServiceSet__p01884100315">DELETE /v1/{project_id}/service-sets/{set_id}</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteServiceSet__table7189010183114" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="DeleteServiceSet__row1218941083117"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="DeleteServiceSet__p1419061003110">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="DeleteServiceSet__p21901510183117">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="DeleteServiceSet__p1819181043118">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="DeleteServiceSet__p1191110133117">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="DeleteServiceSet__row21899108314"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="DeleteServiceSet__p619261013311">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="DeleteServiceSet__p819311018318">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="DeleteServiceSet__p91931910183120">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="DeleteServiceSet__p151941410193112">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="DeleteServiceSet__row1189171073116"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="DeleteServiceSet__p8194111043113">set_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="DeleteServiceSet__p14195141023110">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="DeleteServiceSet__p1519519106310">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="DeleteServiceSet__p1519681014313">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="DeleteServiceSet__b111971310143117">data.records.set_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="DeleteServiceSet__table019891010315" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query Parameters</caption><thead align="left"><tr id="DeleteServiceSet__row7197910143116"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.1"><p id="DeleteServiceSet__p1519851023111">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.2"><p id="DeleteServiceSet__p151998102318">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.3"><p id="DeleteServiceSet__p1019971013311">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.4.2.5.1.4"><p id="DeleteServiceSet__p12200171020319">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="DeleteServiceSet__row1319717106313"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="DeleteServiceSet__p13200110123113">enterprise_project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="DeleteServiceSet__p2201191019314">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="DeleteServiceSet__p11201410203114">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="DeleteServiceSet__p420220108315">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="DeleteServiceSet__b32021106317">0</strong>.</p>
</td>
</tr>
<tr id="DeleteServiceSet__row11197101011313"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="DeleteServiceSet__p420361018311">fw_instance_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="DeleteServiceSet__p8203191013116">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="DeleteServiceSet__p22041810123112">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="DeleteServiceSet__p5205161013314">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="DeleteServiceSet__section72051810133112"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteServiceSet__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request header parameters</caption><thead align="left"><tr id="DeleteServiceSet__row020618103319"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="DeleteServiceSet__p152071010183117">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="DeleteServiceSet__p182081310103116">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="DeleteServiceSet__p13208131014317">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="DeleteServiceSet__p1620951053117">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="DeleteServiceSet__row13206610173113"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="DeleteServiceSet__p021031018316">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="DeleteServiceSet__p162101410103117">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="DeleteServiceSet__p19211101012314">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="DeleteServiceSet__p16211310163117">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="DeleteServiceSet__row16529182323117"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="DeleteServiceSet__p16987185572214">Content-Type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="DeleteServiceSet__p1453216872313">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="DeleteServiceSet__p598785514223">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="DeleteServiceSet__p1821149193417">Content type. It can only be set to application/json.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="DeleteServiceSet__section172121108316"><h4 class="sectiontitle">Response Parameters</h4><p id="DeleteServiceSet__p11213151073120"><strong id="DeleteServiceSet__b1421311100311">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteServiceSet__response_DeleteServiceSetResponseBody" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameters</caption><thead align="left"><tr id="DeleteServiceSet__row62141010153115"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="DeleteServiceSet__p1121571014316">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p id="DeleteServiceSet__p3215181017314">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.4.1.3"><p id="DeleteServiceSet__p1321612103319">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="DeleteServiceSet__row12214181015314"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="DeleteServiceSet__p142161110193111">data</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="DeleteServiceSet__p3217111093115"><a href="#DeleteServiceSet__response_ServiceSetId">ServiceSetId</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="DeleteServiceSet__p13218191073111">Data returned for deleting a service group.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="DeleteServiceSet__response_ServiceSetId"></a><a name="response_ServiceSetId"></a><table cellpadding="4" cellspacing="0" summary="" id="DeleteServiceSet__response_ServiceSetId" frame="border" border="1" rules="all"><caption><b>Table 5 </b>ServiceSetId</caption><thead align="left"><tr id="DeleteServiceSet__row13218610113120"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p id="DeleteServiceSet__p6219121012316">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.2"><p id="DeleteServiceSet__p1822071010311">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.4.2.4.1.3"><p id="DeleteServiceSet__p1322011043114">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="DeleteServiceSet__row17218101019311"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="DeleteServiceSet__p622191010318">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="DeleteServiceSet__p18221141013120">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="DeleteServiceSet__p16222191033113">Service group ID.</p>
</td>
</tr>
<tr id="DeleteServiceSet__row17218151013319"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="DeleteServiceSet__p5222131015314">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="DeleteServiceSet__p522318104310">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="DeleteServiceSet__p1224171014319">Service group name.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="DeleteServiceSet__p5224181011312"><strong id="DeleteServiceSet__b2224810123112">Status code: 400</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteServiceSet__response_ErrorRsp" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Response body parameters</caption><thead align="left"><tr id="DeleteServiceSet__row6225121083118"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.4.1.1"><p id="DeleteServiceSet__p1226151015319">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.4.1.2"><p id="DeleteServiceSet__p422618101313">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.6.2.4.1.3"><p id="DeleteServiceSet__p8227810193117">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="DeleteServiceSet__row1622521010318"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="DeleteServiceSet__p9227191063118">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="DeleteServiceSet__p11228161033118">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="DeleteServiceSet__p3228151043111">Error code.</p>
</td>
</tr>
<tr id="DeleteServiceSet__row722521014313"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="DeleteServiceSet__p12229131043113">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="DeleteServiceSet__p142291910103114">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="DeleteServiceSet__p112306107314">Error description.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="DeleteServiceSet__section162314108316"><h4 class="sectiontitle">Example Requests</h4><p id="DeleteServiceSet__p82312010143119">Delete service group 221cfdca-3abf-4c30-ab0d-516a03c70866 in project 9d80d070b6d44942af73c9c3d38e0429.</p>
<pre class="screen" id="DeleteServiceSet__screen82321810183115">https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/service-sets/221cfdca-3abf-4c30-ab0d-516a03c70866</pre>
</div>
<div class="section" id="DeleteServiceSet__section323313100313"><h4 class="sectiontitle">Example Responses</h4><p id="DeleteServiceSet__p11233410193117"><strong id="DeleteServiceSet__b14234610163110">Status code: 200</strong></p>
<p id="DeleteServiceSet__p1623411103312">Return value for deleting a service group.</p>
<pre class="screen" id="DeleteServiceSet__screen15235131011319">{
"data" : {
"id" : "221cfdca-3abf-4c30-ab0d-516a03c70866",
"name" : "test"
}
}</pre>
<p id="DeleteServiceSet__p623812101314"><strong id="DeleteServiceSet__b142381010123110">Status code: 400</strong></p>
<p id="DeleteServiceSet__p19238151013314">Bad Request</p>
<pre class="screen" id="DeleteServiceSet__screen8239201043120">{
"error_code" : "CFW.00200004",
"error_msg" : "Failed to delete the resource because it is being referenced."
}</pre>
</div>
<div class="section" id="DeleteServiceSet__section1042381023115"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteServiceSet__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="DeleteServiceSet__row13305121013313"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="DeleteServiceSet__p742391063110">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="DeleteServiceSet__p1942318102318">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="DeleteServiceSet__row6305161019318"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="DeleteServiceSet__p154231910103116">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="DeleteServiceSet__p84231710153113">Return value for deleting a service group.</p>
</td>
</tr>
<tr id="DeleteServiceSet__row1130518105317"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="DeleteServiceSet__p7423181016317">400</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="DeleteServiceSet__p12423210133110">Bad Request</p>
</td>
</tr>
<tr id="DeleteServiceSet__row11305110133116"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="DeleteServiceSet__p142319105312">401</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="DeleteServiceSet__p74237105313">Unauthorized</p>
</td>
</tr>
<tr id="DeleteServiceSet__row5305151011312"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="DeleteServiceSet__p1942371010313">403</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="DeleteServiceSet__p134231910183115">Forbidden</p>
</td>
</tr>
<tr id="DeleteServiceSet__row130521063116"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="DeleteServiceSet__p94231810103111">404</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="DeleteServiceSet__p142441003110">Not Found</p>
</td>
</tr>
<tr id="DeleteServiceSet__row143051010123119"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="DeleteServiceSet__p1242441023111">500</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="DeleteServiceSet__p1042431023120">Internal Server Error</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="DeleteServiceSet__section0424510183119"><h4 class="sectiontitle">Error Codes</h4><p id="DeleteServiceSet__p16424141019311">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