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-T.

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+

Name	Description	Type	Notes
container_cluster_path	String Path of the Container Cluster entity Path to the container cluster entity where the request will be executed.	string
enforcement_point_path	String Path of the enforcement point enforcement point path, forward slashes must be escaped using %2F.	string

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+

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
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	ForwardingRuleStatistics list results	array of ForwardingRuleStatisticsForEnforcementPoint	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

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 }

Get forwarding rule statistics.

Request:

StatisticsRequestParameters (schema)

Example Request:

Successful Response:

ForwardingRuleStatisticsListResult (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: