NSX-T Data Center REST API

Get forwarding rule statistics.

Get aggregated statistics of Forwarding Policy Rule.
Stats include total number of packets and total number of bytes for the rule.
- no enforcement point path specified: Stats will be evaluated on each enforcement
point.
- {enforcement_point_path}: Stats are evaluated only on the given enforcement point
This API is available when using VMware Cloud (AWS, Dell-EMC, Outpost, Hyperscalers) or VMware NSX.

Request:

Method:
GET
URI Path(s):
/policy/api/v1/infra/domains/{domain-id}/forwarding-policies/{forwarding-policy-id}/rules/{forwarding-rule-id}/statistics
Request Headers:
n/a
Query Parameters:
StatisticsRequestParameters+
Request Body:
n/a

Example Request:

GET https://<policy-mgr>/policy/api/v1/infra/domains/domain-1/forwarding-policies/pol-1 /rules/rule-21/statistics?enforcement_point_path=/infra/sites/default/enforcement-points/default

Successful Response:

Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
ForwardingRuleStatisticsListResult+

Example Response:

{ "results": [ { "enforcement_point": "/infra/sites/default/enforcement-points/default", "statistics": { "rule": "/infra/domains/domain-1/forwarding-policies/pol-1/rules/rule-21", "internal_rule_id": "3049", "packet_count": 3806, "byte_count": 322989 } } ], "result_count": 1 }

Required Permissions:

read

Feature:

policy_forwarding

Additional Errors: