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

345 lines
26 KiB
HTML
Raw Blame History

<a name="ListDomainSets"></a><a name="ListDomainSets"></a>
<h1 class="topictitle1">Querying the Domain Name Group List</h1>
<div id="body1708331107508"><div class="section" id="ListDomainSets__section196221145329"><h4 class="sectiontitle">Function</h4><p id="ListDomainSets__p2623344322">This API is used to query the domain name group list.</p>
</div>
<div class="section" id="ListDomainSets__section162317414326"><h4 class="sectiontitle">URI</h4><p id="ListDomainSets__p136242414323">GET /v1/{project_id}/domain-sets</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListDomainSets__table56243433216" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="ListDomainSets__row76245413211"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="ListDomainSets__p9625114203214">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="ListDomainSets__p962516418327">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="ListDomainSets__p262512413213">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="ListDomainSets__p1962534183218">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListDomainSets__row462418419328"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="ListDomainSets__p862512423211">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="ListDomainSets__p9626114123216">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="ListDomainSets__p166262414322">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="ListDomainSets__p162614416329">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>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListDomainSets__table196271048323" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query Parameters</caption><thead align="left"><tr id="ListDomainSets__row26278410322"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.1"><p id="ListDomainSets__p66289410327">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.2"><p id="ListDomainSets__p17628848322">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.3"><p id="ListDomainSets__p15628184143214">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.4.2.5.1.4"><p id="ListDomainSets__p8628174173211">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListDomainSets__row1462784183218"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListDomainSets__p2062913413216">enterprise_project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListDomainSets__p17629174143213">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListDomainSets__p176291845325">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListDomainSets__p9629144133210">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="ListDomainSets__b7629348329">0</strong>.</p>
</td>
</tr>
<tr id="ListDomainSets__row7627442325"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListDomainSets__p1063016413323">fw_instance_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListDomainSets__p5630343324">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListDomainSets__p186301543328">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListDomainSets__p106302414326">Firewall ID, which can be obtained by referring to <a href="cfw_02_0028.html">Obtaining a Firewall ID</a>.</p>
</td>
</tr>
<tr id="ListDomainSets__row1062734123220"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListDomainSets__p166311447322">limit</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListDomainSets__p56314417321">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListDomainSets__p1663116443212">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListDomainSets__p263244183215">Number of records displayed on each page. The value ranges from 1 to 1024.</p>
</td>
</tr>
<tr id="ListDomainSets__row166278418326"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListDomainSets__p3632445328">offset</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListDomainSets__p063220483213">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListDomainSets__p106337483212">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListDomainSets__p146330433214">Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is <strong id="ListDomainSets__b186333433214">0</strong>.</p>
</td>
</tr>
<tr id="ListDomainSets__row17627342327"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListDomainSets__p18634544323">object_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListDomainSets__p1263424143219">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListDomainSets__p116341342328">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListDomainSets__p1663616414325">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="ListDomainSets__b3636248323">data.records.protect_objects.object_id</strong> (The period [.] is used to separate different levels of objects). If the value of <strong id="ListDomainSets__b263634123212">type</strong> is <strong id="ListDomainSets__b186367418327">0</strong>, the protected object ID belongs to the Internet border. If the value of <strong id="ListDomainSets__b14636174133212">type</strong> is <strong id="ListDomainSets__b5636134153216">1</strong>, the protected object ID belongs to the VPC border. You can obtain the value of <strong id="ListDomainSets__b116364414324">type</strong> from <strong id="ListDomainSets__b763644103218">data.records.protect_objects.type</strong> (The period [.] is used to separate different levels of objects).</p>
</td>
</tr>
<tr id="ListDomainSets__row17627164103216"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListDomainSets__p463618413210">key_word</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListDomainSets__p863711413219">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListDomainSets__p1463754123215">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListDomainSets__p11637144193216">Keyword, which can be the domain name group name or description.</p>
</td>
</tr>
<tr id="ListDomainSets__row262710419321"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListDomainSets__p96380473218">domain_set_type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListDomainSets__p15638204123214">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListDomainSets__p163919416325">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListDomainSets__p763924133216">Domain name group typ: <strong id="ListDomainSets__b206397420325">0</strong> (application domain name group), <strong id="ListDomainSets__b06391745329">1</strong> (network domain name group).</p>
</td>
</tr>
<tr id="ListDomainSets__row10627343324"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListDomainSets__p196401642325">config_status</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListDomainSets__p1564012433216">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListDomainSets__p146401249320">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListDomainSets__p1264111493215">Configuration status: <strong id="ListDomainSets__b56414413214">-1</strong> (unconfigured), <strong id="ListDomainSets__b1064116423220">0</strong> (configuration failed), <strong id="ListDomainSets__b17641154153219">1</strong> (configuration succeeded), <strong id="ListDomainSets__b1864194133214">2</strong> (configuring), <strong id="ListDomainSets__b18641440320">3</strong> (normal), or <strong id="ListDomainSets__b1064112411328">4</strong> (abnormal).</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ListDomainSets__section1464116411324"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListDomainSets__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request header parameters</caption><thead align="left"><tr id="ListDomainSets__row1164220463220"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="ListDomainSets__p156421413326">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="ListDomainSets__p864220411325">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="ListDomainSets__p96437423219">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="ListDomainSets__p126431040326">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListDomainSets__row196426416325"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="ListDomainSets__p1264304163216">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="ListDomainSets__p206432049327">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="ListDomainSets__p16644445322">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="ListDomainSets__p164444173215">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="ListDomainSets__row498892519321"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="ListDomainSets__p16987185572214">Content-Type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="ListDomainSets__p1453216872313">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="ListDomainSets__p598785514223">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="ListDomainSets__p1821149193417">Content type. It can only be set to application/json.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ListDomainSets__section36451410321"><h4 class="sectiontitle">Response Parameters</h4><p id="ListDomainSets__p2064534123213"><strong id="ListDomainSets__b1264564183216">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListDomainSets__response_ListDomainSetsResponseBody" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameters</caption><thead align="left"><tr id="ListDomainSets__row1464564183214"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="ListDomainSets__p196467473216">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p id="ListDomainSets__p864612414323">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.4.1.3"><p id="ListDomainSets__p1164644173212">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListDomainSets__row13645149329"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ListDomainSets__p56472463217">data</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ListDomainSets__p36471042329"><a href="#ListDomainSets__response_ListDomainsetsResponseData">ListDomainsetsResponseData</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ListDomainSets__p464764123210">Returned data for querying the domain name group list.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ListDomainSets__response_ListDomainsetsResponseData"></a><a name="response_ListDomainsetsResponseData"></a><table cellpadding="4" cellspacing="0" summary="" id="ListDomainSets__response_ListDomainsetsResponseData" frame="border" border="1" rules="all"><caption><b>Table 5 </b>ListDomainsetsResponseData</caption><thead align="left"><tr id="ListDomainSets__row15648164193211"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p id="ListDomainSets__p96487433212">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.2"><p id="ListDomainSets__p9649124173214">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.4.2.4.1.3"><p id="ListDomainSets__p126495411321">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListDomainSets__row166489443212"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListDomainSets__p1064911423218">limit</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListDomainSets__p17649184153213">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListDomainSets__p1464919412326">Number of records displayed on each page. The value ranges from 1 to 1024.</p>
</td>
</tr>
<tr id="ListDomainSets__row464816418328"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListDomainSets__p1865064163210">offset</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListDomainSets__p665014163217">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListDomainSets__p18650134183210">Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is <strong id="ListDomainSets__b26503420327">0</strong>.</p>
</td>
</tr>
<tr id="ListDomainSets__row116480417326"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListDomainSets__p1365174203214">total</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListDomainSets__p1765114103218">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListDomainSets__p46512041320">Total number of domain name groups.</p>
</td>
</tr>
<tr id="ListDomainSets__row196483443212"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListDomainSets__p19651045326">records</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListDomainSets__p66521444328">Array of <a href="#ListDomainSets__response_DomainSetVo">DomainSetVo</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListDomainSets__p146529410329">Domain name group list.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ListDomainSets__response_DomainSetVo"></a><a name="response_DomainSetVo"></a><table cellpadding="4" cellspacing="0" summary="" id="ListDomainSets__response_DomainSetVo" frame="border" border="1" rules="all"><caption><b>Table 6 </b>DomainSetVo</caption><thead align="left"><tr id="ListDomainSets__row4652104153217"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.1"><p id="ListDomainSets__p26535414328">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.2"><p id="ListDomainSets__p7653842328">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.5.2.4.1.3"><p id="ListDomainSets__p865311433220">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListDomainSets__row206521547322"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListDomainSets__p206547418321">set_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListDomainSets__p1265411483210">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListDomainSets__p1665418423218">Domain name group ID.</p>
</td>
</tr>
<tr id="ListDomainSets__row46524433211"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListDomainSets__p186541248326">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListDomainSets__p56554443217">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListDomainSets__p465514414326">Domain name group name.</p>
</td>
</tr>
<tr id="ListDomainSets__row265215418322"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListDomainSets__p165554103214">description</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListDomainSets__p18655134113215">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListDomainSets__p116569453211">Domain name group description.</p>
</td>
</tr>
<tr id="ListDomainSets__row1465218412328"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListDomainSets__p186561044321">ref_count</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListDomainSets__p4656348325">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListDomainSets__p106562453215">Number of times a domain name group is referenced by rules.</p>
</td>
</tr>
<tr id="ListDomainSets__row26529413219"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListDomainSets__p196563418327">domain_set_type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListDomainSets__p56576463217">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListDomainSets__p665744153215">Domain name group typ: <strong id="ListDomainSets__b1965774143213">0</strong> (application domain name group), <strong id="ListDomainSets__b1865734173218">1</strong> (network domain name group).</p>
</td>
</tr>
<tr id="ListDomainSets__row3652124103217"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListDomainSets__p1465704163212">config_status</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListDomainSets__p36582414323">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListDomainSets__p4658648328">Configuration status: <strong id="ListDomainSets__b665804113219">-1</strong> (unconfigured), <strong id="ListDomainSets__b465894193220">0</strong> (configuration failed), <strong id="ListDomainSets__b66588473214">1</strong> (configuration succeeded), <strong id="ListDomainSets__b1565819410327">2</strong> (configuring), <strong id="ListDomainSets__b14658204113216">3</strong> (normal), or <strong id="ListDomainSets__b1565820413216">4</strong> (abnormal).</p>
</td>
</tr>
<tr id="ListDomainSets__row1065211416329"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListDomainSets__p17658164173210">rules</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListDomainSets__p1365911443215">Array of <a href="#ListDomainSets__response_UseRuleVO">UseRuleVO</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListDomainSets__p165912418327">Used rule ID list.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ListDomainSets__response_UseRuleVO"></a><a name="response_UseRuleVO"></a><table cellpadding="4" cellspacing="0" summary="" id="ListDomainSets__response_UseRuleVO" frame="border" border="1" rules="all"><caption><b>Table 7 </b>UseRuleVO</caption><thead align="left"><tr id="ListDomainSets__row196592412327"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.4.1.1"><p id="ListDomainSets__p566014412325">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.4.1.2"><p id="ListDomainSets__p136607493211">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.6.2.4.1.3"><p id="ListDomainSets__p466014183215">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListDomainSets__row1165914433213"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="ListDomainSets__p86611743329">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="ListDomainSets__p1366174113216">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="ListDomainSets__p1466118414327">Rule ID.</p>
</td>
</tr>
<tr id="ListDomainSets__row1865911413322"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="ListDomainSets__p566294153217">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="ListDomainSets__p116621148321">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="ListDomainSets__p196623413324">Rule name.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ListDomainSets__section5662545328"><h4 class="sectiontitle">Example Requests</h4><p id="ListDomainSets__p1266313417329">Query the domain name group list of firewall 546af3f8-88e9-47f2-a205-2346d7090925 in project 9d80d070b6d44942af73c9c3d38e0429. The protected object ID is ae42418e-f077-41a0-9d3b-5b2f5ad9102b.</p>
<pre class="screen" id="ListDomainSets__screen0663841325">https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/domain-sets?fw_instance_id=546af3f8-88e9-47f2-a205-2346d7090925&amp;enterprise_project_id=default&amp;limit=50&amp;offset=0&amp;object_id=ae42418e-f077-41a0-9d3b-5b2f5ad9102b</pre>
</div>
<div class="section" id="ListDomainSets__section266320416323"><h4 class="sectiontitle">Example Responses</h4><p id="ListDomainSets__p1666419420321"><strong id="ListDomainSets__b1366416413329">Status code: 200</strong></p>
<p id="ListDomainSets__p136642453214">Return value for querying the domain name group list.</p>
<pre class="screen" id="ListDomainSets__screen3665174133213">{
"data" : {
"limit" : 50,
"offset" : 0,
"records" : [ {
"config_status" : 3,
"description" : "",
"domain_set_type" : 0,
"name" : "ccdd",
"ref_count" : 0,
"rules" : [ ],
"set_id" : "e43db369-a863-45ed-8850-58d6b571b1ab"
} ],
"total" : 1
}
}</pre>
</div>
<div class="section" id="ListDomainSets__section1179416420322"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListDomainSets__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="ListDomainSets__row1168915403216"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="ListDomainSets__p5795547324">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="ListDomainSets__p117951240321">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListDomainSets__row369012413213"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ListDomainSets__p16795154133220">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ListDomainSets__p20795246326">Return value for querying the domain name group list.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ListDomainSets__section16795648321"><h4 class="sectiontitle">Error Codes</h4><p id="ListDomainSets__p879514411323">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