forked from docs/doc-exports
Reviewed-by: Hajba, László Antal <laszlo-antal.hajba@t-systems.com> Co-authored-by: fanqinying <fanqinying@huawei.com> Co-committed-by: fanqinying <fanqinying@huawei.com>
469 lines
23 KiB
HTML
469 lines
23 KiB
HTML
<a name="ListFirewall"></a><a name="ListFirewall"></a>
|
|
|
|
<h1 class="topictitle1">Querying Network ACLs</h1>
|
|
<div id="body1708331107508"><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to query information about all network ACLs, including the network ACL name and status.</p>
|
|
</div>
|
|
<div class="section" id="ListFirewall__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p>GET /v3/{project_id}/vpc/firewalls</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p>Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p>Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p>Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p>Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p>project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p>Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p>String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p><strong>Definition</strong>:</p>
|
|
<p>ID of the project that the network ACL belongs to.</p>
|
|
<p><strong>Range</strong>:</p>
|
|
<p>N/A</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query Parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.1"><p>Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.2"><p>Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.3"><p>Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.4.2.5.1.4"><p>Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p>limit</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p>No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p>Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p><strong>Definition</strong>:</p>
|
|
<p>Number of resources on each page.</p>
|
|
<p><strong>Range</strong>:</p>
|
|
<p>0 to 2000</p>
|
|
</td>
|
|
</tr>
|
|
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p>marker</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p>No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p>String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p><strong>Definition</strong>:</p>
|
|
<p>Start resource ID of pagination query. If the parameter is left blank, only resources on the first page are queried.</p>
|
|
<p><strong>Range</strong>:</p>
|
|
<p>Network ACL ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p>id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p>No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p>Array of strings</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p><strong>Definition</strong>:</p>
|
|
<p>ID of the network ACL, which can be used to filter the network ACL. Multiple IDs can be specified for filtering.</p>
|
|
<p><strong>Range</strong>:</p>
|
|
<p>N/A</p>
|
|
</td>
|
|
</tr>
|
|
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p>name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p>No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p>Array of strings</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p><strong>Definition</strong>:</p>
|
|
<p>Name of the network ACL, which can be used to filter the network ACL. Multiple names can be specified for filtering.</p>
|
|
<p><strong>Range</strong>:</p>
|
|
<p>N/A</p>
|
|
</td>
|
|
</tr>
|
|
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p>status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p>No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p>String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p><strong>Definition</strong>:</p>
|
|
<p>Network ACL status, which indicates whether the network ACL has been associated with a subnet. This value can be used to filter the network ACL.</p>
|
|
<p><strong>Range</strong>:</p>
|
|
<ul><li><p>ACTIVE: Filter network ACLs that have been associated with subnets.</p>
|
|
</li><li><p>INACTIVE: Filter network ACLs that have not been associated with subnets.</p>
|
|
</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p>admin_state_up</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p>No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p>Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p><strong>Definition</strong>:</p>
|
|
<p>Administrative status of a network ACL, which indicates whether the network ACL is enabled or disabled and can be used to filter the network ACL.</p>
|
|
<p><strong>Range</strong>:</p>
|
|
<ul><li><p>true: Filter network ACLs that are enabled.</p>
|
|
</li><li><p>false: Filter network ACLs that are disabled.</p>
|
|
</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p>enterprise_project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p>No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p>Array of strings</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p><strong>Definition</strong>:</p>
|
|
<p>ID of the enterprise project that the network ACL belongs to. You can use this field to filter network ACLs in an enterprise project.</p>
|
|
<p><strong>Range</strong>:</p>
|
|
<ul><li><p>The value is <strong>0</strong> or a string that contains a maximum of 36 characters in UUID format with hyphens (-). <strong>0</strong> indicates the default enterprise project.</p>
|
|
</li><li><p>To obtain network ACLs of all enterprise projects, set this parameter to <strong>all_granted_eps</strong>.</p>
|
|
</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section"><h4 class="sectiontitle">Request Parameters</h4><p>None</p>
|
|
</div>
|
|
<div class="section"><h4 class="sectiontitle">Response Parameters</h4><p><strong>Status code: 200</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListFirewall__response_ListFirewallResponseBody" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response body parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.3.2.4.1.1"><p>Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.3.2.4.1.2"><p>Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.3.2.4.1.3"><p>Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p>firewalls</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p>Array of <a href="#ListFirewall__response_ListFirewallDetail">ListFirewallDetail</a> objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p><strong>Definition</strong>:</p>
|
|
<p>Response body for querying network ACLs.</p>
|
|
<p><strong>Range</strong>:</p>
|
|
<p>N/A</p>
|
|
</td>
|
|
</tr>
|
|
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p>page_info</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p><a href="#ListFirewall__response_PageInfo">PageInfo</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p><strong>Definition</strong>:</p>
|
|
<p>Pagination information.</p>
|
|
<p><strong>Range</strong>:</p>
|
|
<p>N/A</p>
|
|
</td>
|
|
</tr>
|
|
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p>request_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p>String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p><strong>Definition</strong>:</p>
|
|
<p>Request ID.</p>
|
|
<p><strong>Range</strong>:</p>
|
|
<p>N/A</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="ListFirewall__response_ListFirewallDetail"></a><a name="response_ListFirewallDetail"></a><table cellpadding="4" cellspacing="0" summary="" id="ListFirewall__response_ListFirewallDetail" frame="border" border="1" rules="all"><caption><b>Table 4 </b>ListFirewallDetail</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.4.2.4.1.1"><p>Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.4.2.4.1.2"><p>Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.4.2.4.1.3"><p>Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p>id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p>String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p><strong>Definition</strong>:</p>
|
|
<p>Network ACL ID. Each network ACL comes with an ID, which uniquely identifies the network ACL.</p>
|
|
<p><strong>Range</strong>:</p>
|
|
<p>The value is in UUID format with hyphens (-).</p>
|
|
</td>
|
|
</tr>
|
|
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p>name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p>String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p><strong>Definition</strong>:</p>
|
|
<p>Name of the network ACL.</p>
|
|
<p><strong>Range</strong>:</p>
|
|
<p>The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods.</p>
|
|
</td>
|
|
</tr>
|
|
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p>description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p>String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p><strong>Definition</strong>:</p>
|
|
<p>Supplementary information about the network ACL.</p>
|
|
<p><strong>Range</strong>:</p>
|
|
<p>The value can contain 0 to 255 characters and cannot contain angle brackets (< or >).</p>
|
|
</td>
|
|
</tr>
|
|
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p>project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p>String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p><strong>Definition</strong>:</p>
|
|
<p>ID of the project that the network ACL belongs to.</p>
|
|
<p><strong>Range</strong>:</p>
|
|
<p>N/A</p>
|
|
</td>
|
|
</tr>
|
|
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p>created_at</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p>String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p><strong>Definition</strong>:</p>
|
|
<p>Time when the network ACL was created. The value is automatically generated by the system.</p>
|
|
<p><strong>Range</strong>:</p>
|
|
<p>The value is a UTC time in the format of <em>yyyy-MM-ddTHH:mm:ssZ</em>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p>updated_at</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p>String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p><strong>Definition</strong>:</p>
|
|
<p>Time when the network ACL was last updated. The value is automatically generated by the system.</p>
|
|
<p><strong>Range</strong>:</p>
|
|
<p>The value is a UTC time in the format of <em>yyyy-MM-ddTHH:mm:ssZ</em>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p>admin_state_up</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p>Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p><strong>Definition</strong>:</p>
|
|
<p>Network ACL administrative status.</p>
|
|
<p><strong>Range</strong>:</p>
|
|
<ul><li><p>true: The network ACL is enabled.</p>
|
|
</li><li><p>false: The network ACL is disabled.</p>
|
|
</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p>status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p>String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p><strong>Definition</strong>:</p>
|
|
<p>Network ACL status.</p>
|
|
<p><strong>Range</strong>:</p>
|
|
<ul><li><p>ACTIVE: The network ACL is associated with a subnet.</p>
|
|
</li><li><p>INACTIVE: The network ACL is not associated with a subnet.</p>
|
|
</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p>enterprise_project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p>String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p><strong>Definition</strong>:</p>
|
|
<p>ID of the enterprise project that the network ACL belongs to.</p>
|
|
<p><strong>Range</strong>:</p>
|
|
<p>The value is <strong>0</strong> or a string that contains a maximum of 36 characters in UUID format with hyphens (-). <strong>0</strong> indicates the default enterprise project.</p>
|
|
</td>
|
|
</tr>
|
|
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p>tags</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p>Array of <a href="#ListFirewall__response_ResponseTag">ResponseTag</a> objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p><strong>Definition</strong>:</p>
|
|
<p>Tags of a network ACL, including tag keys and tag values, which can be used to classify and identify resources. For details, see the tag objects.</p>
|
|
<p><strong>Range</strong>:</p>
|
|
<p>N/A</p>
|
|
</td>
|
|
</tr>
|
|
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p>associations</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p>Array of <a href="#ListFirewall__response_FirewallAssociation">FirewallAssociation</a> objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p><strong>Definition</strong>:</p>
|
|
<p>Subnets associated with the network ACL.</p>
|
|
<p><strong>Range</strong>:</p>
|
|
<p>N/A</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="ListFirewall__response_ResponseTag"></a><a name="response_ResponseTag"></a><table cellpadding="4" cellspacing="0" summary="" id="ListFirewall__response_ResponseTag" frame="border" border="1" rules="all"><caption><b>Table 5 </b>ResponseTag</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.5.2.4.1.1"><p>Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.5.2.4.1.2"><p>Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.5.2.4.1.3"><p>Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p>key</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p>String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p><strong>Definition</strong>:</p>
|
|
<p>Tag key.</p>
|
|
<p><strong>Range</strong>:</p>
|
|
<ul><li><p>A tag key can contain a maximum of 128 Unicode characters and cannot be left blank.</p>
|
|
</li><li><p>Each tag key of a resource must be unique.</p>
|
|
</li><li><p>The value can contain:</p>
|
|
<ul><li><p>Letters</p>
|
|
</li><li><p>Digits</p>
|
|
</li><li><p>Special characters: underscores (_), periods (.), colons (:), plus signs (+), hyphens (-), at signs (@), and equal signs (=)</p>
|
|
</li></ul>
|
|
</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p>value</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p>String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p><strong>Definition</strong>:</p>
|
|
<p>Tag value.</p>
|
|
<p><strong>Range</strong>:</p>
|
|
<ul><li><p>Each value can contain a maximum of 255 Unicode characters and can be left blank.</p>
|
|
</li><li><p>The value can contain:</p>
|
|
<ul><li><p>Letters</p>
|
|
</li><li><p>Digits</p>
|
|
</li><li><p>Special characters: underscores (_), colons (:), plus signs (+), hyphens (-), at signs (@), and equal signs (=)</p>
|
|
</li></ul>
|
|
</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="ListFirewall__response_FirewallAssociation"></a><a name="response_FirewallAssociation"></a><table cellpadding="4" cellspacing="0" summary="" id="ListFirewall__response_FirewallAssociation" frame="border" border="1" rules="all"><caption><b>Table 6 </b>FirewallAssociation</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.6.2.4.1.1"><p>Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.6.2.4.1.2"><p>Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.6.2.4.1.3"><p>Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.1 "><p>virsubnet_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.2 "><p>String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.6.2.4.1.3 "><p><strong>Definition</strong>:</p>
|
|
<p>ID of the subnet associated with the network ACL.</p>
|
|
<p><strong>Range</strong>:</p>
|
|
<ul><li><p>If the network ACL type is normal, it can only be associated with common subnets.</p>
|
|
</li><li><p>If the network ACL type is CloudDCN, it can only be associated with CloudDCN subnets.</p>
|
|
</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="ListFirewall__response_PageInfo"></a><a name="response_PageInfo"></a><table cellpadding="4" cellspacing="0" summary="" id="ListFirewall__response_PageInfo" frame="border" border="1" rules="all"><caption><b>Table 7 </b>PageInfo</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.7.2.4.1.1"><p>Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.7.2.4.1.2"><p>Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.7.2.4.1.3"><p>Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.7.2.4.1.1 "><p>previous_marker</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.7.2.4.1.2 "><p>String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.7.2.4.1.3 "><p><strong>Definition</strong>:</p>
|
|
<p>The first record on the current page.</p>
|
|
<p><strong>Range</strong>:</p>
|
|
<p>N/A</p>
|
|
</td>
|
|
</tr>
|
|
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.7.2.4.1.1 "><p>current_count</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.7.2.4.1.2 "><p>Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.7.2.4.1.3 "><p><strong>Definition</strong>:</p>
|
|
<p>Total number of resources on the current page.</p>
|
|
<p><strong>Range</strong>:</p>
|
|
<p>N/A</p>
|
|
</td>
|
|
</tr>
|
|
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.7.2.4.1.1 "><p>next_marker</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.7.2.4.1.2 "><p>String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.7.2.4.1.3 "><p><strong>Definition</strong>:</p>
|
|
<p>The last record on the current page. The <strong>next_marker</strong> field does not exist if the page is the last one.</p>
|
|
<p><strong>Range</strong>:</p>
|
|
<p>N/A</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section"><h4 class="sectiontitle">Example Requests</h4><p>Querying network ACLs</p>
|
|
<pre class="screen">GET https://{Endpoint}/v3/{project_id}/vpc/firewalls</pre>
|
|
</div>
|
|
<div class="section"><h4 class="sectiontitle">Example Responses</h4><p><strong>Status code: 200</strong></p>
|
|
<p>Normal response to the GET operation. For more status codes, see <a href="vpc_api_0002.html">Status Codes</a>.</p>
|
|
<pre class="screen">{
|
|
"firewalls" : [ {
|
|
"id" : "e9a7731d-5bd9-4250-a524-b9a076fd5629",
|
|
"name" : "network_acl_test1",
|
|
"description" : "network_acl_test1",
|
|
"project_id" : "9476ea5a8a9849c38358e43c0c3a9e12",
|
|
"created_at" : "2022-04-07T07:30:46.000+00:00",
|
|
"updated_at" : "2022-04-07T07:30:46.000+00:00",
|
|
"admin_state_up" : true,
|
|
"enterprise_project_id" : "158ad39a-dab7-45a3-9b5a-2836b3cf93f9",
|
|
"status" : "ACTIVE",
|
|
"tags" : [ ],
|
|
"associations" : [ {
|
|
"virsubnet_id" : "8359e5b0-353f-4ef3-a071-98e67a34a143"
|
|
} ]
|
|
} ]
|
|
}</pre>
|
|
</div>
|
|
<div class="section"><h4 class="sectiontitle">Status Codes</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListFirewall__status_code" frame="border" border="1" rules="all"><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p>Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p>Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p>200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p>Normal response to the GET operation. For more status codes, see <a href="vpc_api_0002.html">Status Codes</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section"><h4 class="sectiontitle">Error Codes</h4><p>See <a href="vpc_api_0003.html">Error Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000004.html">Network ACL</a></div>
|
|
</div>
|
|
</div>
|
|
|