Querying Firewall Rules¶
Function¶
This API is used to query all firewall rules accessible to the tenant submitting the request.
URI¶
GET /v2.0/fwaas/firewall_rules
Example:
GET https://{Endpoint}/v2.0/fwaas/firewall_rules?name={firewall_rule_name}&tenant_id={tenant_id}&public={is_public}&protocol={protocol}&ip_version={ip_version}&action={action}&enabled={is_enabled}
Example of querying rules by page
GET https://{Endpoint}/v2.0/fwaas/firewall_rules?limit=2&marker=2a193015-4a88-4aa1-84ad-d4955adae707&page_reverse=False
Table 1 describes the parameters.
Name | Mandatory | Type | Description |
---|---|---|---|
id | No | String | Specifies that the firewall rule ID is used as the filtering condition. |
name | No | String | Specifies that the firewall rule name is used as the filtering condition. |
description | No | String | Specifies that the firewall rule description is used as the filtering condition. |
ip_version | No | Integer | Specifies that the IP address version is used as the filtering condition. The value can be 4 (IPv4) or 6 (IPv6). |
action | No | String | Specifies that the firewall rule action is used as the filtering condition. The value can be allow or deny. |
enabled | No | Boolean | Specifies that the firewall rule is enabled is used as the filtering condition. The value can be true or false. |
tenant_id | No | String | Specifies that the project ID is used as the filtering condition. |
marker | No | String | Specifies a resource ID for pagination query, indicating that the query starts from the next record of the specified resource ID. This parameter can work together with the parameter limit.
|
limit | No | Integer | Specifies the number of records that will be returned on each page. The value is from 0 to intmax (2^31-1). The default value is 2000. limit can be used together with marker. For details, see the parameter description of marker. |
Request Parameters¶
None
Example Request¶
GET https://{Endpoint}/v2.0/fwaas/firewall_rules
Response Parameters¶
Parameter | Type | Description |
---|---|---|
firewall_rules | Array of Firewall Rule objects | Specifies the firewall rule list. For details, see Table 4. |
firewall_rules_links | Array of firewall_rules_link Object | Specifies the pagination information. For details, see Table 3. Only when limit is used for filtering and the number of resources exceeds the value of limit or 2000 (default value of limit), value next will be returned for rel and a link for href. |
Parameter | Type | Description |
---|---|---|
href | String | Specifies the API link. |
rel | String | Specifies the relationship between the API link and the API version. |
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. For details about how to obtain a project ID, see Obtaining a Project ID. |
Example Response¶
{
"firewall_rules": [
{
"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": "2a193015-4a88-4aa1-84ad-d4955adae707",
"name": "crhfwruleupdate",
"tenant_id": "a1c6f90c94334bd2953d9a61b8031a68",
"project_id": "a1c6f90c94334bd2953d9a61b8031a68",
"enabled": true,
"action": "allow",
"ip_version": 4,
"public": false
},
{
"protocol": "tcp",
"description": "update check parameter",
"source_ip_address": null,
"destination_ip_address": null,
"destination_port": "40:60",
"source_port": "20:50",
"id": "db7a204c-9eb1-40a2-9bd6-ed5cfd3cff32",
"name": "update_firewall-role-tommy",
"tenant_id": "a1c6f90c94334bd2953d9a61b8031a68",
"project_id": "a1c6f90c94334bd2953d9a61b8031a68",
"enabled": false,
"action": "deny",
"ip_version": 4,
"public": false
}
],
"firewall_rules_links": [
{ "rel": "previous",
"href": "https://{Endpoint}/v2.0/fwaas/firewall_rules?marker=2a193015-4a88-4aa1-84ad-d4955adae707&page_reverse=True"
}
]
}
Status Code¶
See Status Codes.
Error Code¶
See Error Codes.