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

525 lines
39 KiB
HTML
Raw Blame History

<a name="ListFirewallList"></a><a name="ListFirewallList"></a>
<h1 class="topictitle1">Querying the Firewall List</h1>
<div id="body1708331107508"><div class="section" id="ListFirewallList__section1106174217223"><h4 class="sectiontitle">Function</h4><p id="ListFirewallList__p610694213224">This API is used to query a firewall list.</p>
</div>
<div class="section" id="ListFirewallList__section310794232219"><h4 class="sectiontitle">URI</h4><p id="ListFirewallList__p1610714212227">POST /v1/{project_id}/firewalls/list</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListFirewallList__table9107144222214" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="ListFirewallList__row1910744216224"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="ListFirewallList__p81088429220">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="ListFirewallList__p210824217223">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="ListFirewallList__p11108842152220">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="ListFirewallList__p171082427229">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListFirewallList__row210724220222"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="ListFirewallList__p121082424227">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="ListFirewallList__p12108042122215">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="ListFirewallList__p16108114242213">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="ListFirewallList__p1710884217221">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="ListFirewallList__table131091429225" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query Parameters</caption><thead align="left"><tr id="ListFirewallList__row111091042152211"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.1"><p id="ListFirewallList__p4109144222215">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.2"><p id="ListFirewallList__p81093423223">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.3"><p id="ListFirewallList__p91099428221">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.4.2.5.1.4"><p id="ListFirewallList__p3109164232214">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListFirewallList__row18109042192216"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListFirewallList__p1511094213228">enterprise_project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListFirewallList__p01103421223">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListFirewallList__p9110194216227">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListFirewallList__p711017421221">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="ListFirewallList__b14110642172214">0</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ListFirewallList__section1811064219222"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListFirewallList__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request header parameters</caption><thead align="left"><tr id="ListFirewallList__row201102042102212"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="ListFirewallList__p5111134216227">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="ListFirewallList__p411114420228">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="ListFirewallList__p5111104215224">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="ListFirewallList__p14111204219222">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListFirewallList__row4110194222216"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="ListFirewallList__p121111942112220">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="ListFirewallList__p191115428227">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="ListFirewallList__p4111164219222">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="ListFirewallList__p211116421225">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="ListFirewallList__row14412131717273"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="ListFirewallList__p16987185572214">Content-Type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="ListFirewallList__p1453216872313">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="ListFirewallList__p598785514223">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="ListFirewallList__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="ListFirewallList__request_QueryFireWallInstanceDto" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Request body parameters</caption><thead align="left"><tr id="ListFirewallList__row1711284220223"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="ListFirewallList__p1411210423223">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="ListFirewallList__p4112204282213">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="ListFirewallList__p171136426222">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.2.5.1.4"><p id="ListFirewallList__p1911384219229">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListFirewallList__row1911224282217"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="ListFirewallList__p141131842142216">enterprise_project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="ListFirewallList__p211314272213">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="ListFirewallList__p31131742122214">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="ListFirewallList__p11137425224">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="ListFirewallList__b6113442202213">0</strong>.</p>
</td>
</tr>
<tr id="ListFirewallList__row111129422228"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="ListFirewallList__p18114184211224">key_word</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="ListFirewallList__p181141442182214">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="ListFirewallList__p4114942192211">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="ListFirewallList__p1311494222218">Query keyword, which can be a firewall ID or part of a firewall name. You can obtain the firewall ID by referring to <a href="cfw_02_0028.html">Obtaining a Firewall ID</a>.</p>
</td>
</tr>
<tr id="ListFirewallList__row101121042182216"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="ListFirewallList__p1211454202213">tags</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="ListFirewallList__p1311434210225">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="ListFirewallList__p211494217229">Array of <a href="#ListFirewallList__request_TagInfo">TagInfo</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="ListFirewallList__p811474282217">Tag list, which can be obtained by calling the API for querying tags. The return value is the tag list.</p>
</td>
</tr>
<tr id="ListFirewallList__row1211294282211"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="ListFirewallList__p171144424227">limit</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="ListFirewallList__p1711504219220">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="ListFirewallList__p3115104211223">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="ListFirewallList__p1711510427225">Number of records displayed on each page. The value ranges from 1 to 1024.</p>
</td>
</tr>
<tr id="ListFirewallList__row111274262210"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="ListFirewallList__p11115842112210">offset</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="ListFirewallList__p1211524222219">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="ListFirewallList__p121154428226">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="ListFirewallList__p1911584242218">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="ListFirewallList__b1211564211228">0</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ListFirewallList__request_TagInfo"></a><a name="request_TagInfo"></a><table cellpadding="4" cellspacing="0" summary="" id="ListFirewallList__request_TagInfo" frame="border" border="1" rules="all"><caption><b>Table 5 </b>TagInfo</caption><thead align="left"><tr id="ListFirewallList__row1211524210226"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.1"><p id="ListFirewallList__p12116164211225">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.2"><p id="ListFirewallList__p811634232217">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.3"><p id="ListFirewallList__p711613421223">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.4.2.5.1.4"><p id="ListFirewallList__p161162426222">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListFirewallList__row1811615429227"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="ListFirewallList__p151171842132210">key</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="ListFirewallList__p111171742162215">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="ListFirewallList__p1611711428229">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="ListFirewallList__p13117842102215">Tag key.</p>
</td>
</tr>
<tr id="ListFirewallList__row11116144222215"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="ListFirewallList__p141171742172217">values</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="ListFirewallList__p141172421226">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="ListFirewallList__p1111744217222">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="ListFirewallList__p2011724212211">Tag value list.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ListFirewallList__section11181142132215"><h4 class="sectiontitle">Response Parameters</h4><p id="ListFirewallList__p4118124212224"><strong id="ListFirewallList__b81181042102211">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListFirewallList__response_HttpFirewallInstanceListResponse" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Response body parameters</caption><thead align="left"><tr id="ListFirewallList__row5118134242216"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="ListFirewallList__p6119042172215">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p id="ListFirewallList__p11192426223">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.4.1.3"><p id="ListFirewallList__p18119242102218">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListFirewallList__row1011811420224"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ListFirewallList__p911974216223">user_support_eps</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ListFirewallList__p18119134216227">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ListFirewallList__p1119042112212">Whether enterprise projects are supported: <strong id="ListFirewallList__b13119942162212">true</strong> (yes), <strong id="ListFirewallList__b12119242142219">false</strong> (no).</p>
</td>
</tr>
<tr id="ListFirewallList__row811813427226"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ListFirewallList__p711918428229">has_ndr</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ListFirewallList__p711914218226">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ListFirewallList__p91201842202211">Whether NDR exists: <strong id="ListFirewallList__b17120104292212">true</strong> (yes), <strong id="ListFirewallList__b1112014220227">false</strong> (no). NDR is the original out-of-path firewall and is no longer sold.</p>
</td>
</tr>
<tr id="ListFirewallList__row7118144212223"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ListFirewallList__p5120154232218">is_support_postpaid</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ListFirewallList__p51209425228">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ListFirewallList__p2012084282216">Whether pay-per-use purchase is supported: <strong id="ListFirewallList__b1012019429220">true</strong> (yes), <strong id="ListFirewallList__b191201542112211">false</strong> (no).</p>
</td>
</tr>
<tr id="ListFirewallList__row41180424227"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ListFirewallList__p812044222211">is_support_basic_version</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ListFirewallList__p81202428224">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ListFirewallList__p1712018422224">Whether the basic edition is supported: <strong id="ListFirewallList__b1412034213226">true</strong> (yes), <strong id="ListFirewallList__b111201342142212">false</strong> (no).</p>
</td>
</tr>
<tr id="ListFirewallList__row0118742152215"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ListFirewallList__p3120184252217">is_support_buy_professional</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ListFirewallList__p20120204282220">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ListFirewallList__p121218420229">Whether the professional edition can be purchased: <strong id="ListFirewallList__b112174262212">true</strong> (yes), <strong id="ListFirewallList__b171216423227">false</strong> (no).</p>
</td>
</tr>
<tr id="ListFirewallList__row12118154232217"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ListFirewallList__p16121542152215">data</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ListFirewallList__p7121942132215"><a href="#ListFirewallList__response_HttpFirewallInstanceListResponseData">HttpFirewallInstanceListResponseData</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ListFirewallList__p17121104218226">Data returned for querying the firewall list.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ListFirewallList__response_HttpFirewallInstanceListResponseData"></a><a name="response_HttpFirewallInstanceListResponseData"></a><table cellpadding="4" cellspacing="0" summary="" id="ListFirewallList__response_HttpFirewallInstanceListResponseData" frame="border" border="1" rules="all"><caption><b>Table 7 </b>HttpFirewallInstanceListResponseData</caption><thead align="left"><tr id="ListFirewallList__row20121184282212"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p id="ListFirewallList__p16122204272219">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.2"><p id="ListFirewallList__p19122174216225">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.4.2.4.1.3"><p id="ListFirewallList__p412254219221">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListFirewallList__row01211542162217"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListFirewallList__p1612264217226">limit</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListFirewallList__p14122542102218">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListFirewallList__p17122134242211">Number of records displayed on each page. The value ranges from 1 to 1024.</p>
</td>
</tr>
<tr id="ListFirewallList__row141210422223"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListFirewallList__p141230425226">offset</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListFirewallList__p812304272216">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListFirewallList__p1812314427224">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="ListFirewallList__b131231442102214">0</strong>.</p>
</td>
</tr>
<tr id="ListFirewallList__row1012124262218"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListFirewallList__p61231242192218">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListFirewallList__p141232421228">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListFirewallList__p14123124222214">Tenant project ID</p>
</td>
</tr>
<tr id="ListFirewallList__row1212124218229"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListFirewallList__p6123134232217">total</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListFirewallList__p12123114211222">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListFirewallList__p101236426225">Total number of firewalls.</p>
</td>
</tr>
<tr id="ListFirewallList__row712112422227"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListFirewallList__p412315423224">records</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListFirewallList__p1612484222210">Array of <a href="#ListFirewallList__response_FirewallInstanceVO">FirewallInstanceVO</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListFirewallList__p1012464262218">Query the firewall list.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ListFirewallList__response_FirewallInstanceVO"></a><a name="response_FirewallInstanceVO"></a><table cellpadding="4" cellspacing="0" summary="" id="ListFirewallList__response_FirewallInstanceVO" frame="border" border="1" rules="all"><caption><b>Table 8 </b>FirewallInstanceVO</caption><thead align="left"><tr id="ListFirewallList__row612419423226"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.1"><p id="ListFirewallList__p912564232219">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.2"><p id="ListFirewallList__p31252424224">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.5.2.4.1.3"><p id="ListFirewallList__p1212517424222">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListFirewallList__row612474217224"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListFirewallList__p5125164292213">fw_instance_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListFirewallList__p191255424227">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListFirewallList__p17125184222215">Firewall instance ID, which is automatically generated by the system after a CFW instance is created.</p>
</td>
</tr>
<tr id="ListFirewallList__row151241842162217"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListFirewallList__p1012694252212">resource_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListFirewallList__p1612618427224">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListFirewallList__p13126242142218">Resource ID, which is the same as the firewall instance ID <strong id="ListFirewallList__b512615429222">fw_instance_id</strong>.</p>
</td>
</tr>
<tr id="ListFirewallList__row14124194272210"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListFirewallList__p1126642112218">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListFirewallList__p912614220221">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListFirewallList__p18126144242215">Firewall creation timestamp.</p>
</td>
</tr>
<tr id="ListFirewallList__row141241442202214"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListFirewallList__p1812644262216">fw_instance_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListFirewallList__p1126842122211">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListFirewallList__p1012684213225">Firewall name.</p>
</td>
</tr>
<tr id="ListFirewallList__row51249426221"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListFirewallList__p15126842182217">enterprise_project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListFirewallList__p1212724232213">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListFirewallList__p412734212220">Enterprise project ID, which is generated after the enterprise project is supported for a user.</p>
</td>
</tr>
<tr id="ListFirewallList__row01242427221"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListFirewallList__p312774222210">ha_type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListFirewallList__p13127242182213">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListFirewallList__p8127144212214">Cluster type: <strong id="ListFirewallList__b4127142152211">0</strong> (active/standby), <strong id="ListFirewallList__b1812714425224">1</strong> (cluster). In active/standby mode, there are four nodes. Two active nodes form a cluster, and the other two are the standby of the active nodes. In cluster mode, only two nodes are started to form a cluster.</p>
</td>
</tr>
<tr id="ListFirewallList__row15124142152218"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListFirewallList__p81271442162213">charge_mode</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListFirewallList__p41271842142213">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListFirewallList__p8127144219226">Billing mode: <strong id="ListFirewallList__b1512734222211">0</strong> (yearly/monthly), <strong id="ListFirewallList__b14127742132217">1</strong> (pay-per-use).</p>
</td>
</tr>
<tr id="ListFirewallList__row11241428222"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListFirewallList__p181277423223">service_type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListFirewallList__p11128144211224">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListFirewallList__p19128164218220">Firewall protection type. Currently, its value can only be <strong id="ListFirewallList__b41281342112219">0</strong> (Internet protection).</p>
</td>
</tr>
<tr id="ListFirewallList__row1812484212215"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListFirewallList__p8128144202212">engine_type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListFirewallList__p912894202217">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListFirewallList__p912819429222">Engine type: <strong id="ListFirewallList__b0129194282218">0</strong> (self-developed engine), <strong id="ListFirewallList__b012911429227">1</strong> (Hillstone engine), or <strong id="ListFirewallList__b2012994212211">3</strong> (TOPSEC engine).</p>
</td>
</tr>
<tr id="ListFirewallList__row51241642202216"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListFirewallList__p1412944222210">flavor</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListFirewallList__p131298420224"><a href="#ListFirewallList__response_Flavor">Flavor</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListFirewallList__p81291942142211">Firewall specifications.</p>
</td>
</tr>
<tr id="ListFirewallList__row812454292214"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListFirewallList__p19129442122214">status</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListFirewallList__p14130124252216">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListFirewallList__p1413024292219">Firewall status: <strong id="ListFirewallList__b161307426227">-1</strong> (waiting for payment), <strong id="ListFirewallList__b17130154292217">0</strong> (creating), <strong id="ListFirewallList__b213054217223">1</strong> (deleting), <strong id="ListFirewallList__b11130442102218">2</strong> (running), <strong id="ListFirewallList__b101301342182213">3</strong> (upgrading), <strong id="ListFirewallList__b7130042172219">4</strong> (deleted), <strong id="ListFirewallList__b161302425227">5</strong> (frozen), <strong id="ListFirewallList__b20130742162212">6</strong> (creation failed), <strong id="ListFirewallList__b141301842132219">7</strong> (deletion failed), <strong id="ListFirewallList__b1213084210229">8</strong> (freezing failed), or <strong id="ListFirewallList__b161301242122214">9</strong> (being stored), <strong id="ListFirewallList__b201303425226">10</strong> (storage failed), or <strong id="ListFirewallList__b1813084210224">11</strong> (upgrade failed).</p>
</td>
</tr>
<tr id="ListFirewallList__row15125142192211"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListFirewallList__p17130042182217">tags</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListFirewallList__p713024214222">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListFirewallList__p17130114217222">Tag list, which is a JSON string converted from the tag key value map, for example, "{"key":"value"}".</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ListFirewallList__response_Flavor"></a><a name="response_Flavor"></a><table cellpadding="4" cellspacing="0" summary="" id="ListFirewallList__response_Flavor" frame="border" border="1" rules="all"><caption><b>Table 9 </b>Flavor</caption><thead align="left"><tr id="ListFirewallList__row41311542122219"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.4.1.1"><p id="ListFirewallList__p171317421227">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.4.1.2"><p id="ListFirewallList__p3132124216225">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.6.2.4.1.3"><p id="ListFirewallList__p14132742192219">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListFirewallList__row81311442202218"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="ListFirewallList__p71321542182213">version</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="ListFirewallList__p111322429225">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="ListFirewallList__p19132242192217">Firewall version. Its value can only be <strong id="ListFirewallList__b1613213427224">1</strong> (professional edition).</p>
</td>
</tr>
<tr id="ListFirewallList__row61318425221"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="ListFirewallList__p0132114282218">eip_count</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="ListFirewallList__p121323424222">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="ListFirewallList__p2133642132214">Number of EIPs.</p>
</td>
</tr>
<tr id="ListFirewallList__row1013120429229"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="ListFirewallList__p15133134282215">vpc_count</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="ListFirewallList__p5133104222218">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="ListFirewallList__p151338427229">Number of VPCs.</p>
</td>
</tr>
<tr id="ListFirewallList__row1813114216221"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="ListFirewallList__p161331542132210">bandwidth</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="ListFirewallList__p11331442132218">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="ListFirewallList__p18133124282218">Bandwidth, in Mbit/s.</p>
</td>
</tr>
<tr id="ListFirewallList__row71311642102215"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="ListFirewallList__p61331842162218">log_storage</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="ListFirewallList__p1713324272216">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="ListFirewallList__p1513319421225">Log storage, in bytes.</p>
</td>
</tr>
<tr id="ListFirewallList__row813116420221"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="ListFirewallList__p413415422227">default_bandwidth</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="ListFirewallList__p181341642162214">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="ListFirewallList__p141349429227">Default firewall bandwidth, in Mbit/s. The value is 10 for the standard edition, 50 for the professional edition, and 200 for the pay-per-use professional edition.</p>
</td>
</tr>
<tr id="ListFirewallList__row18131104212212"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="ListFirewallList__p213419428222">default_eip_count</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="ListFirewallList__p10134164212214">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="ListFirewallList__p1913464242216">Default number of EIPs. The value is 20 for the standard edition, 50 for the professional edition, and 1,000 for the pay-per-use professional edition.</p>
</td>
</tr>
<tr id="ListFirewallList__row11131242112219"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="ListFirewallList__p18134144282211">default_log_storage</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="ListFirewallList__p1913454282219">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="ListFirewallList__p61341842162210">Default log storage, in bytes. The default value is <strong id="ListFirewallList__b1413564214222">0</strong>.</p>
</td>
</tr>
<tr id="ListFirewallList__row813104217220"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="ListFirewallList__p12135144217222">default_vpc_count</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="ListFirewallList__p1513524213225">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="ListFirewallList__p1813554272219">Default number of VPCs. The value is 0 for the standard edition, 2 for the professional edition, and 5 for the pay-per-use professional edition.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ListFirewallList__section413517421223"><h4 class="sectiontitle">Example Requests</h4><p id="ListFirewallList__p81357427229">Query the firewall list on the first page of the enterprise project whose ID is all_granted_eps and project ID is 14181c1245cf4fd786824efe1e2b9388.</p>
<pre class="screen" id="ListFirewallList__screen413512429220">https://{Endpoint}/v1/14181c1245cf4fd786824efe1e2b9388/firewalls/list?enterprise_project_id=all_granted_eps
{
"limit" : 10,
"offset" : 0
}</pre>
</div>
<div class="section" id="ListFirewallList__section15469423225"><h4 class="sectiontitle">Example Responses</h4><p id="ListFirewallList__p1954624232210"><strong id="ListFirewallList__b0546134211229">Status code: 200</strong></p>
<p id="ListFirewallList__p7546194232214">Return value for querying the firewall list.</p>
<pre class="screen" id="ListFirewallList__screen854614428228">{
"data" : {
"limit" : 1,
"offset" : 0,
"project_id" : "14181c1245cf4fd786824efe1e2b9388",
"records" : [ {
"fw_instance_id" : "ebf891cd-2163-48a0-9963-6309f99dd3c4",
"resource_id" : "ebf891cd-2163-48a0-9963-6309f99dd3c4",
"name" : "1709176078374",
"fw_instance_name" : "test",
"enterprise_project_id" : "default",
"tags" : "{\"key_test3\":\"value_test3\"}",
"ha_type" : 0,
"charge_mode" : 0,
"service_type" : 0,
"engine_type" : 1,
"flavor" : {
"version" : 1,
"eip_count" : 50,
"vpc_count" : 6,
"bandwidth" : 50,
"log_storage" : 0,
"default_eip_count" : 50,
"default_vpc_count" : 2,
"default_bandwidth" : 50,
"default_log_storage" : 0
},
"status" : 2
} ],
"total" : 18
},
"has_ndr" : false,
"is_support_basic_version" : true,
"is_support_buy_professional" : false,
"is_support_postpaid" : true,
"user_support_eps" : false
}</pre>
</div>
<div class="section" id="ListFirewallList__section125481142202216"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListFirewallList__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="ListFirewallList__row1146114217222"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="ListFirewallList__p6548174242219">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="ListFirewallList__p95481142132219">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListFirewallList__row71461442142213"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ListFirewallList__p1354824272215">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ListFirewallList__p185491042132212">Return value for querying the firewall list.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ListFirewallList__section654910429225"><h4 class="sectiontitle">Error Codes</h4><p id="ListFirewallList__p1854934212227">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_300000000.html">Firewall Management</a></div>
</div>
</div>
View Git Blame Copy Permalink