NSX-T Data Center REST API

Get transit gateway NAT Rule Statistics

Get transit gateway NAT Rule Statistics from transit gateway denoted by transit-gateway-id,
under NAT section
denoted by <nat-id>.
Under transit gateway there will be 2 different NATs(sections).
(USER and NAT64)
For more details related to NAT section please refer to PolicyNAT schema.

Request:

Method:

GET

URI Path(s):

/policy/api/v1/orgs/{org-id}/projects/{project-id}/transit-gateways/{transit-gateway-id}/nat/{nat-id}/nat-rules/{nat-rule-id}/statistics

Request Headers:

n/a

Query Parameters:

PolicyStatisticsAggregateParameters+

PolicyStatisticsAggregateParameters (schema)

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+

PolicyNatRuleStatisticsListResult (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
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	List of NAT rule statistics per enforcement point For every enforcement point, it lists the warning message of NAT rule statistics, the current number of active traffic sessions matching the NAT rule, and the total number of packets and bytes processed on the NAT rule since the time the rule was created.	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": "/orgs/org1/projects/project1/vpcs/vpc1/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 } ] } ] }

Required Permissions:

read

Feature:

policy_transit_gateway

Additional Errors:

• 301 Moved Permanently
• 307 Temporary Redirect
• 400 Bad Request
• 403 Forbidden
• 409 Conflict
• 412 Precondition Failed
• 500 Internal Server Error
• 503 Service Unavailable