NSX-T Data Center REST API

Get tier-0 router link statistics summary information

Get tier-0 router link statistics summary information. In case tier 1 is A/A, and the edge cluster is not
the response will have interface_policy_path and logical_router_port_id empty because all logical router
port stats are aggregated from all edge nodes.

Request:

Method:

GET

URI Path(s):

/policy/api/v1/infra/tier-0s/{tier-0-id}/tier-1-interface/statistics/summary
/policy/api/v1/global-infra/tier-0s/{tier-0-id}/tier-1-interface/statistics/summary

Request Headers:

n/a

Query Parameters:

RouterLinkRuntimeRequestParameters+

RouterLinkRuntimeRequestParameters (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 should be member of enforcement point. It is mandantory for router link interface statistics and ARP-table APIs.	string
enforcement_point_path	String Path of the enforcement point Enforcement point path.	string
include_mark_for_delete_objects	Include objects that are marked for deletion in results If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.	boolean	Default: "False"
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
tier1_path	Policy path of tier1 Policy path of tier1.	string	Required

Request Body:

n/a

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

PolicyInterfaceStatisticsSummary+

PolicyInterfaceStatisticsSummary (schema)

Name	Description	Type	Notes
interface_policy_path	Policy path for the interface Policy path for the interface	string
last_update_timestamp	Timestamp when the data was last updated; unset if data source has never updated the data.	EpochMsTimestamp	Readonly
logical_router_port_id	The ID of the logical router port	string	Required
rx	Packets in statistics Provides the aggregated incoming packet counters on the logical router port. It includes the total number of packets received, dropped, and the number of errors and failures causing the drops. The counters are from the time the logical router port was created. The statistics from a given transport node will be reset on edge reboot or edge dataplane restart of that node.	LogicalRouterPortCounters	Readonly
tx	Packets out statistics Provides the aggregated outcoming packet counters on the logical router port. It includes the total number of packets sent, dropped, and the number of errors and failures causing the drops. The counters are from the time the logical router port was created. The statistics from a given transport node will be reset on edge reboot or edge dataplane restart of that node.	LogicalRouterPortCounters	Readonly

Example Response:

{ "interface_policy_path": "/infra/realized-state/enforcement-points/default/logical-ports/pepsi-production_t1-t0_lrp", "last_update_timestamp": 1705966281748, "rx": { "total_bytes": 205842, "total_packets": 4901, "dropped_packets": 401 }, "tx": { "total_bytes": 0, "total_packets": 0, "dropped_packets": 0 }, "logical_router_port_id": "603a02fe-919b-53c4-a5bb-5cd905438108" }

Required Permissions:

read

Feature:

policy_t0

Additional Errors:

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