Help Center> Virtual Private Cloud> API Reference> Native OpenStack Neutron APIs (V2.0)> Network ACL> Querying Network ACL Policies
View PDF

Querying Network ACL Policies

Function

This API is used to query all network ACL policies accessible to the tenant submitting the request. A maximum of 2000 records can be returned for each query operation. If the number of records exceeds 2000, the pagination marker will be returned. For details, see section Pagination.

URI

GET /v2.0/fwaas/firewall_policies

Example of querying policies by page

GET https://{Endpoint}/v2.0/fwaas/firewall_policies?limit=2&marker=6b70e321-0c21-4b83-bb8a-a886d1414a5f&page_reverse=False

Table 1 describes the parameters.

Table 1 Parameter description

Name

Mandatory

Type

Description

id

No

String

Specifies that the ID is used as the filtering condition.

name

No

String

Specifies that the name is used as the filtering condition.

description

No

String

Specifies that the description is used as the filtering condition.

tenant_id

No

String

Specifies that the project ID is used as the filtering condition.

marker

No

String

Specifies the start resource ID of pagination query. If the parameter is left blank, only resources on the first page are queried.

limit

No

Integer

Specifies the number of records on each page. The value ranges from 0 to intmax.

Request Message

None

Response Message

Table 2 Response parameter

Parameter

Type

Description

firewall_policies

Array of firewall Policy object

Specifies the firewall policy objects. For details, see Table 3.

firewall_policies_links

Array of firewall_policies_link object

firewall_policies_link object For details, see Table 4.
Table 3 firewall_Policy object

Attribute

Type

Description

id

String

Specifies the UUID of the network ACL policy.

name

String

Specifies the name of the network ACL policy.

description

String

Provides supplementary information about the network ACL policy.

tenant_id

String

Specifies the project ID.

firewall_rules

Array of strings

Specifies the firewall rules referenced by the network ACL policy.

audited

Boolean

Specifies the audit flag.

public

Boolean

Specifies whether the firewall policy can be shared by different tenants.

project_id

String

Specifies the project ID. For details about how to obtain a project ID, see Obtaining a Project ID.
Table 4 firewall_policies_link object

Name

Type

Description

href

String

Specifies the API link.

rel

String

Specifies the relationship between the API link and the API version.

Example

Example request

GET https://{Endpoint}/v2.0/fwaas/firewall_policies

Example response

{
    "firewall_policies": [
        {
            "description": "", 
            "firewall_rules": [
                "6c6803e0-ca8c-4aa9-afb3-4f89275b6c32"
            ], 
            "tenant_id": "23c8a121505047b6869edf39f3062712", 
            "public": false, 
            "id": "6b70e321-0c21-4b83-bb8a-a886d1414a5f", 
            "audited": false, 
            "name": "fwp1",
            "project_id": "23c8a121505047b6869edf39f3062712"
        }, 
        {
            "description": "", 
            "firewall_rules": [
                "6c6803e0-ca8c-4aa9-afb3-4f89275b6c32"
            ], 
            "tenant_id": "23c8a121505047b6869edf39f3062712", 
            "public": false, 
            "id": "fce92002-5a15-465d-aaca-9b44453bb738", 
            "audited": false, 
            "name": "fwp2",
            "project_id": "23c8a121505047b6869edf39f3062712"
        }
    ]
}

Status Code

See Status Codes.

Error Code

See Error Codes.

Parent topic: Network ACL