NSX-T Data Center REST API

Get forwarding policy statistics.

Get aggregated stattistics of Forwarding Policy.
Stats include total number of packets and total number of bytes for all
Forwarding rules in a given Forwarding Policy.
- 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-T.

Request:

Method:
GET
URI Path(s):
/policy/api/v1/infra/domains/<domain-id>/forwarding-policies/<forwarding-policy-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/forwarding-policy-1 /statistics?enforcement_point_path=/infra/sites/default/enforcement-points/default

Successful Response:

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

Example Response:

{ "results": [ { "enforcement_point": "/infra/sites/default/enforcement-points/default", "statistics": { "internal_section_id": "fcb7390d-8289-4a0e-9cee-5423748cc544", "results": [ { "internal_rule_id": "1", "packet_count": 3806, "byte_count": 322989, "_schema": "ForwardingRule" } ], "result_count": 1 } } ], "result_count": 1 }

Required Permissions:

read

Feature:

policy_forwarding

Additional Errors: