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

Querying a Network ACL Rule

Function

This API is used to query details about a specific network ACL rule.

URI

GET /v2.0/fwaas/firewall_rules/{firewall_rule_id}

Table 1 describes the parameters.

Table 1 Parameter description

Name

Mandatory

Type

Description

firewall_rule_id

Yes

String

Specifies the network ACL rule ID, which uniquely identifies the network ACL rule. The firewall_rule_id value is used as the filter.

Request Message

None

Response Message

Table 2 Response parameter

Parameter

Type

Description

firewall_rule

Object

Specifies the firewall rule objects. For details, see Table 3.
Table 3 Firewall Rule objects

Attribute

Type

Description

id

String

Specifies the UUID of the network ACL rule.

name

String

Specifies the network ACL rule name.

description

String

Provides supplementary information about the network ACL rule.

tenant_id

String

Specifies the project ID.

public

Boolean

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

protocol

String

Specifies the IP protocol.

source_port

String

Specifies the source port number or port number range.

destination_port

String

Specifies the destination port number or port number range.

ip_version

Integer

Specifies the IP protocol version.

source_ip_address

String

Specifies the source IP address or CIDR block.

destination_ip_address

String

Specifies the destination IP address or CIDR block.

action

String

Specifies action performed on traffic passing through the network ACL.

enabled

Boolean

Specifies whether the network ACL rule is enabled.

project_id

String

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

Example:

Example request

GET https://{Endpoint}/v2.0/fwaas/firewall_rules/514e6776-162a-4b5d-ab8b-aa36b86655ef

Example response

{
    "firewall_rule": {
        "protocol": "tcp", 
        "name": "bobby_rule", 
        "mode": "normal", 
        "tenant_id": "4490a89232ce46d4ae4bfb227ef1a40a", 
        "rule_profile": "", 
        "enabled": true, 
        "source_port": null, 
        "source_ip_address": null, 
        "destination_ip_address": null, 
        "firewall_policy_id": null, 
        "action": "allow", 
        "position": null, 
        "ip_version": 4, 
        "shared": false, 
        "destination_port": null, 
        "id": "514e6776-162a-4b5d-ab8b-aa36b86655ef", 
        "description": "",
        "project_id": "4490a89232ce46d4ae4bfb227ef1a40a"
    }
}

Status Code

See Status Codes.

Error Code

See Error Codes.

Parent topic: Network ACL