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

189 lines
14 KiB
HTML
Raw Blame History

<a name="DeleteDomainSet"></a><a name="DeleteDomainSet"></a>
<h1 class="topictitle1">Deleting a Domain Name Group</h1>
<div id="body1708331107508"><div class="section" id="DeleteDomainSet__section1694455111312"><h4 class="sectiontitle">Function</h4><p id="DeleteDomainSet__p494435115313">This API is used to delete a domain name group.</p>
</div>
<div class="section" id="DeleteDomainSet__section79441451173116"><h4 class="sectiontitle">URI</h4><p id="DeleteDomainSet__p794412518319">DELETE /v1/{project_id}/domain-set/{set_id}</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteDomainSet__table6945651103113" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="DeleteDomainSet__row8944105143117"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="DeleteDomainSet__p2945151163115">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="DeleteDomainSet__p199451351123115">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="DeleteDomainSet__p1594565173116">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="DeleteDomainSet__p2945451103111">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="DeleteDomainSet__row12944175110317"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="DeleteDomainSet__p19945105113117">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="DeleteDomainSet__p09451351173118">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="DeleteDomainSet__p194595113316">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="DeleteDomainSet__p494555153117">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="DeleteDomainSet__row99449511318"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="DeleteDomainSet__p3945155114315">set_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="DeleteDomainSet__p19467518313">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="DeleteDomainSet__p1694645117318">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="DeleteDomainSet__p594675118317">Domain name group ID, which can be obtained by calling the <a href="ListDomainSets.html">API for querying the domain name group list</a>. Find the value in <strong id="DeleteDomainSet__b394615517311">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="DeleteDomainSet__table294620519312" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query Parameters</caption><thead align="left"><tr id="DeleteDomainSet__row5946651153116"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.1"><p id="DeleteDomainSet__p4946155117316">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.2"><p id="DeleteDomainSet__p794645118317">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.3"><p id="DeleteDomainSet__p1594735111318">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.4.2.5.1.4"><p id="DeleteDomainSet__p15947205163113">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="DeleteDomainSet__row1394613514314"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="DeleteDomainSet__p29471451103119">enterprise_project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="DeleteDomainSet__p2094725111312">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="DeleteDomainSet__p1947165133112">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="DeleteDomainSet__p49474517318">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="DeleteDomainSet__b79471351113119">0</strong>.</p>
</td>
</tr>
<tr id="DeleteDomainSet__row09461751133113"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="DeleteDomainSet__p1994745183111">fw_instance_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="DeleteDomainSet__p1947195110316">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="DeleteDomainSet__p494765117315">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="DeleteDomainSet__p894713511318">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="DeleteDomainSet__section394713511310"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteDomainSet__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request header parameters</caption><thead align="left"><tr id="DeleteDomainSet__row794816519317"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="DeleteDomainSet__p1694835114317">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="DeleteDomainSet__p13948751193116">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="DeleteDomainSet__p1594812513315">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="DeleteDomainSet__p139481051133116">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="DeleteDomainSet__row2948175115317"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="DeleteDomainSet__p1694816511316">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="DeleteDomainSet__p17948651123110">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="DeleteDomainSet__p18948125133116">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="DeleteDomainSet__p18949195163114">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="DeleteDomainSet__row489611819322"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="DeleteDomainSet__p16987185572214">Content-Type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="DeleteDomainSet__p1453216872313">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="DeleteDomainSet__p598785514223">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="DeleteDomainSet__p1821149193417">Content type. It can only be set to application/json.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="DeleteDomainSet__section194925113113"><h4 class="sectiontitle">Response Parameters</h4><p id="DeleteDomainSet__p994975111313"><strong id="DeleteDomainSet__b19949351123119">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteDomainSet__response_DeleteDomainSetResponseBody" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameters</caption><thead align="left"><tr id="DeleteDomainSet__row179491251133113"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="DeleteDomainSet__p29491251113110">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p id="DeleteDomainSet__p794917519313">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.4.1.3"><p id="DeleteDomainSet__p10949115173118">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="DeleteDomainSet__row20949135111311"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="DeleteDomainSet__p1994965118319">data</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="DeleteDomainSet__p1895055115314"><a href="#DeleteDomainSet__response_DomainSetResponseData">DomainSetResponseData</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="DeleteDomainSet__p169503518312">Returned data for deleting a domain name group.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="DeleteDomainSet__response_DomainSetResponseData"></a><a name="response_DomainSetResponseData"></a><table cellpadding="4" cellspacing="0" summary="" id="DeleteDomainSet__response_DomainSetResponseData" frame="border" border="1" rules="all"><caption><b>Table 5 </b>DomainSetResponseData</caption><thead align="left"><tr id="DeleteDomainSet__row159503517318"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p id="DeleteDomainSet__p2950115163116">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.2"><p id="DeleteDomainSet__p995018514319">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.4.2.4.1.3"><p id="DeleteDomainSet__p15950115110311">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="DeleteDomainSet__row169501851183111"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="DeleteDomainSet__p1295018510318">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="DeleteDomainSet__p18951951153112">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="DeleteDomainSet__p1995116511312">Domain name group ID.</p>
</td>
</tr>
<tr id="DeleteDomainSet__row59501251143115"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="DeleteDomainSet__p8951125153118">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="DeleteDomainSet__p7951851113115">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="DeleteDomainSet__p9951175114310">Domain name group name.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="DeleteDomainSet__section1095165133119"><h4 class="sectiontitle">Example Requests</h4><p id="DeleteDomainSet__p1095175111319">Delete domain name group 89bce6a4-9b59-4d7a-b5f9-cac5ac16d88a from firewall 7a004e79-0b8b-4679-ab20-267f3946e8ba in project 9d80d070b6d44942af73c9c3d38e0429.</p>
<pre class="screen" id="DeleteDomainSet__screen169511051133116">https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/domain-set/89bce6a4-9b59-4d7a-b5f9-cac5ac16d88a?fw_instance_id=7a004e79-0b8b-4679-ab20-267f3946e8ba&amp;enterprise_project_id=default</pre>
</div>
<div class="section" id="DeleteDomainSet__section2952105115315"><h4 class="sectiontitle">Example Responses</h4><p id="DeleteDomainSet__p14952155173116"><strong id="DeleteDomainSet__b595225111317">Status code: 200</strong></p>
<p id="DeleteDomainSet__p149524511313">Return value for deleting a domain name group.</p>
<pre class="screen" id="DeleteDomainSet__screen59521951123110">{
"data" : {
"id" : "89bce6a4-9b59-4d7a-b5f9-cac5ac16d88a",
"name" : "test"
}
}</pre>
</div>
<div class="section" id="DeleteDomainSet__section176165219312"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteDomainSet__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="DeleteDomainSet__row199611451153119"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="DeleteDomainSet__p1076135214317">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="DeleteDomainSet__p137645253111">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="DeleteDomainSet__row1896135115317"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="DeleteDomainSet__p11767525312">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="DeleteDomainSet__p276175263119">Return value for deleting a domain name group.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="DeleteDomainSet__section1776165219313"><h4 class="sectiontitle">Error Codes</h4><p id="DeleteDomainSet__p1276155213112">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_300000006.html">Domain Name Resolution and Domain Name Group Management</a></div>
</div>
</div>
View Git Blame Copy Permalink