yexinru/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
Files
12211d6d9cbd2bfdb18aadc10faed67f3ac77bc2
doc-exports/docs/cfw/api-ref/DeleteAddressSet.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="DeleteAddressSet"></a><a name="DeleteAddressSet"></a>
<h1 class="topictitle1">Deleting an Address Group</h1>
<div id="body1708331107508"><div class="section" id="DeleteAddressSet__section181181414303"><h4 class="sectiontitle">Function</h4><p id="DeleteAddressSet__p14119142305">This API is used to delete an address group.</p>
</div>
<div class="section" id="DeleteAddressSet__section4114141303"><h4 class="sectiontitle">URI</h4><p id="DeleteAddressSet__p1811814133014">DELETE /v1/{project_id}/address-sets/{set_id}</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteAddressSet__table312614113019" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="DeleteAddressSet__row111231410303"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="DeleteAddressSet__p111271433012">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="DeleteAddressSet__p5128141309">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="DeleteAddressSet__p1412101416302">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="DeleteAddressSet__p31231418307">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="DeleteAddressSet__row1712191433011"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="DeleteAddressSet__p1113914183015">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="DeleteAddressSet__p1113914173018">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="DeleteAddressSet__p4131914153020">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="DeleteAddressSet__p101319149308">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="DeleteAddressSet__row7121814163015"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="DeleteAddressSet__p16131144306">set_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="DeleteAddressSet__p121381416301">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="DeleteAddressSet__p71314140301">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="DeleteAddressSet__p8139143305">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="DeleteAddressSet__b1213171453011">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="DeleteAddressSet__table314131493019" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query Parameters</caption><thead align="left"><tr id="DeleteAddressSet__row1713314193019"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.1"><p id="DeleteAddressSet__p914161483014">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.2"><p id="DeleteAddressSet__p191414143306">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.3"><p id="DeleteAddressSet__p214171473018">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.4.2.5.1.4"><p id="DeleteAddressSet__p11481417304">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="DeleteAddressSet__row113101423019"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="DeleteAddressSet__p131461403010">enterprise_project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="DeleteAddressSet__p1814181413018">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="DeleteAddressSet__p914614183010">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="DeleteAddressSet__p131441414309">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="DeleteAddressSet__b11145140303">0</strong>.</p>
</td>
</tr>
<tr id="DeleteAddressSet__row131317141306"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="DeleteAddressSet__p20141414203012">fw_instance_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="DeleteAddressSet__p171481415303">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="DeleteAddressSet__p111501413309">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="DeleteAddressSet__p16151414183011">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="DeleteAddressSet__section815171433020"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteAddressSet__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request header parameters</caption><thead align="left"><tr id="DeleteAddressSet__row715214163010"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="DeleteAddressSet__p1915111411304">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="DeleteAddressSet__p315181414309">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="DeleteAddressSet__p1151814153010">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="DeleteAddressSet__p13158142300">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="DeleteAddressSet__row161531415303"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="DeleteAddressSet__p71613143304">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="DeleteAddressSet__p316181493020">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="DeleteAddressSet__p1916151483014">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="DeleteAddressSet__p141621414303">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="DeleteAddressSet__row12256629113012"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="DeleteAddressSet__p16987185572214">Content-Type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="DeleteAddressSet__p1453216872313">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="DeleteAddressSet__p598785514223">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="DeleteAddressSet__p1821149193417">Content type. It can only be set to application/json.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="DeleteAddressSet__section121681412306"><h4 class="sectiontitle">Response Parameters</h4><p id="DeleteAddressSet__p5161214143015"><strong id="DeleteAddressSet__b191641433016">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteAddressSet__response_DeleteAddressSetInfoResponse" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameters</caption><thead align="left"><tr id="DeleteAddressSet__row616814183012"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="DeleteAddressSet__p416171473014">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p id="DeleteAddressSet__p1817014163015">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.4.1.3"><p id="DeleteAddressSet__p19170148303">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="DeleteAddressSet__row15164142306"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="DeleteAddressSet__p817121412302">data</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="DeleteAddressSet__p2171114193019"><a href="#DeleteAddressSet__response_AddressSetId">AddressSetId</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="DeleteAddressSet__p1178147309">Data returned after an address group is deleted.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="DeleteAddressSet__response_AddressSetId"></a><a name="response_AddressSetId"></a><table cellpadding="4" cellspacing="0" summary="" id="DeleteAddressSet__response_AddressSetId" frame="border" border="1" rules="all"><caption><b>Table 5 </b>AddressSetId</caption><thead align="left"><tr id="DeleteAddressSet__row1817181414304"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p id="DeleteAddressSet__p81711141307">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.2"><p id="DeleteAddressSet__p1617161453020">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.4.2.4.1.3"><p id="DeleteAddressSet__p218201463012">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="DeleteAddressSet__row17179145309"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="DeleteAddressSet__p13181814123018">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="DeleteAddressSet__p71820145301">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="DeleteAddressSet__p8181814183014">Address group ID.</p>
</td>
</tr>
<tr id="DeleteAddressSet__row10178145306"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="DeleteAddressSet__p218171411301">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="DeleteAddressSet__p131831443018">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="DeleteAddressSet__p2018171483015">IP address group name.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="DeleteAddressSet__p3181143303"><strong id="DeleteAddressSet__b131881483017">Status code: 400</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteAddressSet__response_ErrorRsp" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Response body parameters</caption><thead align="left"><tr id="DeleteAddressSet__row818191483019"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.4.1.1"><p id="DeleteAddressSet__p141961415304">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.4.1.2"><p id="DeleteAddressSet__p17191149308">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.6.2.4.1.3"><p id="DeleteAddressSet__p21921453017">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="DeleteAddressSet__row1118514193019"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="DeleteAddressSet__p01931423018">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="DeleteAddressSet__p1419121413306">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="DeleteAddressSet__p7198149305">Error code.</p>
</td>
</tr>
<tr id="DeleteAddressSet__row1118191410302"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="DeleteAddressSet__p131941483011">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="DeleteAddressSet__p019181411307">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="DeleteAddressSet__p819414143012">Error description.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="DeleteAddressSet__section1819151493012"><h4 class="sectiontitle">Example Requests</h4><p id="DeleteAddressSet__p1319131415306">Delete address group cf18f0b1-0ce7-4eb8-83b6-4b33c8448e16 from project 9d80d070b6d44942af73c9c3d38e0429.</p>
<pre class="screen" id="DeleteAddressSet__screen820201433016">https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/address-sets/cf18f0b1-0ce7-4eb8-83b6-4b33c8448e16</pre>
</div>
<div class="section" id="DeleteAddressSet__section7201714123011"><h4 class="sectiontitle">Example Responses</h4><p id="DeleteAddressSet__p10202146303"><strong id="DeleteAddressSet__b1520181411303">Status code: 200</strong></p>
<p id="DeleteAddressSet__p42017141307">Return value for deleting an address group.</p>
<pre class="screen" id="DeleteAddressSet__screen52021463018">{
"data" : {
"id" : "cf18f0b1-0ce7-4eb8-83b6-4b33c8448e16",
"name" : "test"
}
}</pre>
<p id="DeleteAddressSet__p5204143304"><strong id="DeleteAddressSet__b52081423010">Status code: 400</strong></p>
<p id="DeleteAddressSet__p42021483015">Bad Request</p>
<pre class="screen" id="DeleteAddressSet__screen15211914133017">{
"error_code" : "CFW.00200004",
"error_msg" : "Failed to delete the resource because it is being referenced."
}</pre>
</div>
<div class="section" id="DeleteAddressSet__section1513951453017"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteAddressSet__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="DeleteAddressSet__row729201414305"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="DeleteAddressSet__p20139171418303">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="DeleteAddressSet__p713941420307">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="DeleteAddressSet__row112941433018"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="DeleteAddressSet__p713991403020">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="DeleteAddressSet__p913911147309">Return value for deleting an address group.</p>
</td>
</tr>
<tr id="DeleteAddressSet__row42941493020"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="DeleteAddressSet__p1713991419301">400</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="DeleteAddressSet__p18139214123014">Bad Request</p>
</td>
</tr>
<tr id="DeleteAddressSet__row182911418309"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="DeleteAddressSet__p813901443014">401</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="DeleteAddressSet__p91396147307">Unauthorized</p>
</td>
</tr>
<tr id="DeleteAddressSet__row16298144308"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="DeleteAddressSet__p1013915144309">403</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="DeleteAddressSet__p14139171415309">Forbidden</p>
</td>
</tr>
<tr id="DeleteAddressSet__row5298146307"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="DeleteAddressSet__p1613918144303">404</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="DeleteAddressSet__p151397145301">Not Found</p>
</td>
</tr>
<tr id="DeleteAddressSet__row429714103019"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="DeleteAddressSet__p4139201413309">500</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="DeleteAddressSet__p714051413015">Internal Server Error</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="DeleteAddressSet__section3140101416304"><h4 class="sectiontitle">Error Codes</h4><p id="DeleteAddressSet__p1714018149303">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