Querying a Firewall Rule¶

Function¶

This API is used to query details about a specific firewall 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 firewall rule ID, which uniquely identifies the firewall rule. The firewall_rule_id value is used as the filter.

Request Parameters¶

None

Example Request¶

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

Response Parameters¶

**Table 2** Response parameter¶
Parameter	Type	Description
firewall_rule	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 firewall rule.
name	String	Specifies the firewall rule name.
description	String	Provides supplementary information about the firewall 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 firewall.
enabled	Boolean	Specifies whether the firewall rule is enabled.
project_id	String	Specifies the project ID.

Example Response¶

{
    "firewall_rule": {
        "protocol": "tcp",
        "description": "update check parameter",
        "source_ip_address": "116.66.184.0/24",
        "destination_ip_address": "0.0.0.0/0",
        "destination_port": null,
        "source_port": null,
        "id": "514e6776-162a-4b5d-ab8b-aa36b86655ef",
        "name": "test",
        "tenant_id": "a1c6f90c94334bd2953d9a61b8031a68",
        "project_id": "a1c6f90c94334bd2953d9a61b8031a68",
        "enabled": true,
        "action": "allow",
        "ip_version": 4,
        "public": false
    }
}

Status Code¶

See Status Codes.

Error Code¶

See Error Codes.

last updated: 2024-05-10 00:06