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/DeleteDomains.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 Permalink Blame History

<a name="DeleteDomains"></a><a name="DeleteDomains"></a>
<h1 class="topictitle1">Deleting a Domain Name List</h1>
<div id="body1708331107508"><div class="section" id="DeleteDomains__section1724113219328"><h4 class="sectiontitle">Function</h4><p id="DeleteDomains__p132493213215">This API is used to delete a domain name list.</p>
</div>
<div class="section" id="DeleteDomains__section924183203212"><h4 class="sectiontitle">URI</h4><p id="DeleteDomains__p1724193219329">DELETE /v1/{project_id}/domain-set/domains/{set_id}</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteDomains__table16251232113213" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="DeleteDomains__row8251329323"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="DeleteDomains__p1125432143219">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="DeleteDomains__p42523216326">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="DeleteDomains__p22513217321">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="DeleteDomains__p4253324323">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="DeleteDomains__row192563216329"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="DeleteDomains__p142520321322">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="DeleteDomains__p10261932113212">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="DeleteDomains__p626103283212">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="DeleteDomains__p0265321329">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="DeleteDomains__row22517328323"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="DeleteDomains__p7262328323">set_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="DeleteDomains__p192619324325">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="DeleteDomains__p1926133273212">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="DeleteDomains__p42663214323">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="DeleteDomains__b4261632123219">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="DeleteDomains__table1427232143216" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query Parameters</caption><thead align="left"><tr id="DeleteDomains__row1526173223215"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.1"><p id="DeleteDomains__p162703273215">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.2"><p id="DeleteDomains__p172712329322">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.3"><p id="DeleteDomains__p727133223213">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.4.2.5.1.4"><p id="DeleteDomains__p122717320326">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="DeleteDomains__row727832133220"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="DeleteDomains__p132723213320">enterprise_project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="DeleteDomains__p10271232103218">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="DeleteDomains__p82803243217">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="DeleteDomains__p22883211324">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="DeleteDomains__b152813253212">0</strong>.</p>
</td>
</tr>
<tr id="DeleteDomains__row2271322328"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="DeleteDomains__p122853210329">fw_instance_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="DeleteDomains__p1428332143219">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="DeleteDomains__p6283327323">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="DeleteDomains__p2028193211321">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="DeleteDomains__section7281832173212"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteDomains__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request header parameters</caption><thead align="left"><tr id="DeleteDomains__row1728193213321"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="DeleteDomains__p229232173219">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="DeleteDomains__p15291332133216">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="DeleteDomains__p172911329327">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="DeleteDomains__p8291432123220">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="DeleteDomains__row1529123217322"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="DeleteDomains__p1029163273218">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="DeleteDomains__p92920323328">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="DeleteDomains__p829113233213">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="DeleteDomains__p330332143214">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="DeleteDomains__row350845216325"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="DeleteDomains__p16987185572214">Content-Type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="DeleteDomains__p1453216872313">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="DeleteDomains__p598785514223">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="DeleteDomains__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="DeleteDomains__request_DeleteDomainDto" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Request body parameters</caption><thead align="left"><tr id="DeleteDomains__row163083215329"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="DeleteDomains__p1130132183210">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="DeleteDomains__p230113212328">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="DeleteDomains__p173093273210">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.2.5.1.4"><p id="DeleteDomains__p33063233214">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="DeleteDomains__row430173263216"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="DeleteDomains__p133116322327">object_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="DeleteDomains__p331123218324">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="DeleteDomains__p163193273212">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="DeleteDomains__p93113325329">Protected object ID, which is used to distinguish between Internet border protection and VPC border protection after a cloud firewall is created. You can obtain the ID by calling the <a href="ListFirewallDetail.html">API for querying firewall instances</a>. In the return value, find the ID in <strong id="DeleteDomains__b173115325320">data.records.protect_objects.object_id</strong> (The period [.] is used to separate different levels of objects). If the value of <strong id="DeleteDomains__b131032173211">type</strong> is <strong id="DeleteDomains__b1531153283219">0</strong>, the protected object ID belongs to the Internet border. If the value of <strong id="DeleteDomains__b831143214329">type</strong> is <strong id="DeleteDomains__b4311132153218">1</strong>, the protected object ID belongs to the VPC border. You can obtain the value of <strong id="DeleteDomains__b1631133223220">type</strong> from <strong id="DeleteDomains__b93103210328">data.records.protect_objects.type</strong> (The period [.] is used to separate different levels of objects).</p>
</td>
</tr>
<tr id="DeleteDomains__row73073293219"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="DeleteDomains__p83183203210">domain_address_ids</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="DeleteDomains__p63117323322">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="DeleteDomains__p1231163215325">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="DeleteDomains__p231173212325">Domain name ID list. Domain name IDs can be obtained by calling the <a href="ListDomains.html">API for querying the domain name list under a domain name group</a>. Find the value in <strong id="DeleteDomains__b932143217321">data.records.domain_address_id</strong> (The period [.] is used to separate different levels of objects).</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="DeleteDomains__section1332332133214"><h4 class="sectiontitle">Response Parameters</h4><p id="DeleteDomains__p1432153263218"><strong id="DeleteDomains__b63233217328">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteDomains__response_DeleteDomainsResponseBody" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Response body parameters</caption><thead align="left"><tr id="DeleteDomains__row20322324326"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="DeleteDomains__p73273283213">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p id="DeleteDomains__p1432532123213">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.4.1.3"><p id="DeleteDomains__p8323322329">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="DeleteDomains__row932133203217"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="DeleteDomains__p123316324328">data</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="DeleteDomains__p8338327328"><a href="#DeleteDomains__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="DeleteDomains__p1633173213323">Returned data for deleting a domain name list.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="DeleteDomains__response_DomainSetResponseData"></a><a name="response_DomainSetResponseData"></a><table cellpadding="4" cellspacing="0" summary="" id="DeleteDomains__response_DomainSetResponseData" frame="border" border="1" rules="all"><caption><b>Table 6 </b>DomainSetResponseData</caption><thead align="left"><tr id="DeleteDomains__row133932183210"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p id="DeleteDomains__p633183214321">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.2"><p id="DeleteDomains__p734113217327">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.4.2.4.1.3"><p id="DeleteDomains__p1234163215320">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="DeleteDomains__row10331327324"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="DeleteDomains__p2034132183218">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="DeleteDomains__p1034032193219">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="DeleteDomains__p1341432153210">Domain name group ID.</p>
</td>
</tr>
<tr id="DeleteDomains__row113313203215"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="DeleteDomains__p2341532133218">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="DeleteDomains__p834183217327">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="DeleteDomains__p33417324325">Domain name group name.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="DeleteDomains__section634832123218"><h4 class="sectiontitle">Example Requests</h4><p id="DeleteDomains__p13418329321">In project 14181c1245cf4fd786824efe1e2b9388, delete domain names from domain name group 78719348-6d79-477e-acec-676a29842ab2. The firewall ID is 546af3f8-88e9-47f2-a205-2346d7090925, the protected object ID is ae42418e-f077-41a0-9d3b-5b2f5ad9102b, the domain name group ID is 78719348-6d79-477e-acec-676a29842ab2, and the domain list is "b9c23ad8-16d2-4f14-894f-29250c5d27e5", "c36f9462-467b-4303-9734-f9abc38ddb95".</p>
<pre class="screen" id="DeleteDomains__screen1535123293218">https://{Endpoint}/v1/14181c1245cf4fd786824efe1e2b9388/domain-set/domains/78719348-6d79-477e-acec-676a29842ab2?fw_instance_id=546af3f8-88e9-47f2-a205-2346d7090925&amp;enterprise_project_id=default
{
"domain_address_ids" : [ "b9c23ad8-16d2-4f14-894f-29250c5d27e5", "c36f9462-467b-4303-9734-f9abc38ddb95" ],
"object_id" : "ae42418e-f077-41a0-9d3b-5b2f5ad9102b"
}</pre>
</div>
<div class="section" id="DeleteDomains__section73563243219"><h4 class="sectiontitle">Example Responses</h4><p id="DeleteDomains__p153533293216"><strong id="DeleteDomains__b23523253220">Status code: 200</strong></p>
<p id="DeleteDomains__p83573283210">Return value for deleting a domain name list.</p>
<pre class="screen" id="DeleteDomains__screen1836113220326">{
"data" : {
"id" : "78719348-6d79-477e-acec-676a29842ab2",
"name" : "test26"
}
}</pre>
</div>
<div class="section" id="DeleteDomains__section19162133212324"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteDomains__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="DeleteDomains__row20474326321"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="DeleteDomains__p1416213323327">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="DeleteDomains__p1162103219328">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="DeleteDomains__row3471032163210"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="DeleteDomains__p9162133213217">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="DeleteDomains__p616373233212">Return value for deleting a domain name list.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="DeleteDomains__section1216343212322"><h4 class="sectiontitle">Error Codes</h4><p id="DeleteDomains__p1316353210325">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