Get NAT Rule Statistics

Get NAT Rule Statistics from Tier-1 denoted by Tier-1 ID, under NAT section
denoted by <nat-id>.
Under tier-1 there will be 3 different NATs(sections).
(INTERNAL, USER and DEFAULT)
For more details related to NAT section please refer to PolicyNAT schema.
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/tier-1s/{tier-1-id}/nat/{nat-id}/nat-rules/{nat-rule-id}/statistics
/policy/api/v1/global-infra/tier-1s/{tier-1-id}/nat/{nat-id}/nat-rules/{nat-rule-id}/statistics
/policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/nat/{nat-id}/nat-rules/{nat-rule-id}/statistics

Request Headers:

n/a

Query Parameters:

PolicyStatisticsAggregateParameters+

Name	Description	Type	Notes
action	Action on statistics Action to take on statistics for an object.	string	Enum: aggregate
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

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

PolicyNatRuleStatisticsListResult+

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	NAT rules statistics per enforcement point	array of PolicyNatRuleStatisticsPerEnforcementPoint	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": [ { "rule_path": "/infra/tier-1s/network/nat/USER/nat-rules/1", "enforcement_point_path": "/infra/sites/default/enforcement-points/default", "rule_statistics": [ { "total_bytes": 0, "active_sessions": 0, "total_packets": 0, "last_update_timestamp": 1537502752201 }, { "total_bytes": 0, "active_sessions": 0, "total_packets": 0, "last_update_timestamp": 1537502753915 } ] } ] }

Get NAT Rule Statistics

Request:

PolicyStatisticsAggregateParameters (schema)

Successful Response:

PolicyNatRuleStatisticsListResult (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: