Get Firewall rule level statistics

Get aggregated statistics for a rule for given firewall section. The
API only supports access to cached (source=cached) statistical data
collected offline in the system. Data includes total number of packets,
bytes, sessions counters and popularity index for a firewall rule and
overall session count, max session count and max popularity index for
all firewall rules on transport nodes or edge nodes. Aggregated
statistics like maximum popularity index, maximum session count and
total session count are computed with lower frequency compared to
individual generic rule statistics, hence they may have a computation
delay up to 15 minutes to reflect in response to this API.

Request:

Method:

GET

URI Path(s):

/api/v1/firewall/sections/<section-id>/rules/<rule-id>/stats

Request Headers:

n/a

Query Parameters:

DataSourceParameters+

Name	Description	Type	Notes
source	The data source, either realtime or cached. If not provided, cached data is returned.	DataSourceType

Request Body:

n/a

Example Request:

GET https://<nsx-mgr>/api/v1/firewall/sections/d1cba5d1-02dc-4507-b6e8-117cb050e71d/rules/2/stats

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

FirewallStats+

FirewallStats (schema)

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
byte_count	Bytes count Aggregated number of bytes processed by the rule.	integer	Readonly
hit_count	Hits count Aggregated number of hits received by the rule.	integer	Readonly
max_popularity_index	The maximum popularity index Maximum value of popularity index of all firewall rules of the type. This is aggregated statistic which are computed with lower frequency compared to individual generic rule statistics. It may have a computation delay up to 15 minutes in response to this API.	integer	Readonly
max_session_count	Maximum sessions count Maximum value of sessions count of all firewall rules of the type. This is aggregated statistic which are computed with lower frequency compared to generic rule statistics. It may have a computation delay up to 15 minutes in response to this API.	integer	Readonly
packet_count	Packets count Aggregated number of packets processed by the rule.	integer	Readonly
popularity_index	The index of the popularity of firewall rule This is calculated by sessions count divided by age of the rule.	integer	Readonly
rule_id	Firewall rule Id Rule Identifier of the Firewall rule. This is a globally unique number.	string	Readonly
session_count	Sessions count Aggregated number of sessions processed by the rule.	integer	Readonly
total_session_count	Total sessions count Aggregated number of sessions processed by the all firewall rules. This is aggregated statistic which are computed with lower frequency compared to individual generic rule statistics. It may have a computation delay up to 15 minutes in response to this API.	integer	Readonly

Example Response:

{ "rule_id": "2", "packet_count": 3806, "session_count": 819, "hit_count": 819, "byte_count": 322989, "popularity_index": 85, "max_popularity_index": 85, "max_session_count": 819, "total_session_count" : 819, "_schema": "FirewallRule" }

Get Firewall rule level statistics

Request:

DataSourceParameters (schema)

Example Request:

Successful Response:

FirewallStats (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: