Get statistics for downlink router port on tier-0 router

Segment ID is the ID of the segment that is connected to the the tier-0

Request:

Method:

GET

URI Path(s):

/policy/api/v1/infra/segments/{segment-id}/gateway-interface-statistics
/policy/api/v1/global-infra/segments/{segment-id}/gateway-interface-statistics
/policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}/gateway-interface-statistics

Request Headers:

n/a

Query Parameters:

BaseEdgeStatisticsRequestParameters+

BaseEdgeStatisticsRequestParameters (schema)

Name	Description	Type	Notes
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
edge_path	Policy path of edge node Policy path of edge node. Edge node must be member of enforcement point. Edge path is required when interface specified is either service or loopback interface.	string
enforcement_point_path	Enforcement point path String Path of the enforcement point. When not specified, routes from all enforcement-points are returned. This property is required for retrieving routes in CSV format.	string
host_transport_node_path	Policy path of host transport node Policy path of host transport node. In case of API used from Global Manager, use the HostTransportNode path from Local Manager.	string
included_fields	Comma separated list of fields that should be included in query result Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string

Request Body:

n/a

Example Request:

https://{{nsx-mgr}}/policy/api/v1/infra/segments/TIER0_DOWNLINK_SWITCH/gateway-interface-statistics?edge_path=/infra/sites/default/enforcement-points/default/edge-clusters/7f7d37a7-b78e-4378-949d-09190cbfef7d/edge-nodes/a831390e-a7c8-11ea-9102-020063e79023

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

PolicyInterfaceStatistics+

Name	Description	Type	Notes
logical_router_port_id	The ID of the logical router port	string	Required
per_node_statistics	Per Node Statistics	array of LogicalRouterPortStatisticsPerNode	Readonly

Example Response:

{ "logical_router_port_id": "/infra/tier-1s/TLR1_LR", "per_node_statistics": [ { "last_update_timestamp": 1591806707306, "rx": { "total_bytes": 78780, "total_packets": 1313, "dropped_packets": 94459 }, "tx": { "total_bytes": 57559796, "total_packets": 813354, "dropped_packets": 94459 } } ] }

Get statistics for downlink router port on tier-0 router

Request:

BaseEdgeStatisticsRequestParameters (schema)

Example Request:

Successful Response:

PolicyInterfaceStatistics (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: