Read the NSX Manager/Controller's Network Interface Statistics

On the specified interface, returns the number of received (rx), transmitted
(tx), and dropped packets; the number of bytes and errors received and
transmitted on the interface; and the number of detected collisions.

Request:

Method:

GET

URI Path(s):

/api/v1/cluster/nodes/<node-id>/network/interfaces/<interface-id>/stats

Request Headers:

n/a

Query Parameters:

DataSourceParameters+

Name	Description	Type	Notes
source	The data source, either realtime or cached. If not provided, cached data is returned.	DataSourceType

Request Body:

n/a

Example Request:

GET https://<nsx-mgr>/api/v1/cluster/nodes/<node-id>/network/interfaces/<interface-id>/stats

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

NodeInterfaceStatisticsProperties+

NodeInterfaceStatisticsProperties (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
interface_id	Interface ID	string
rx_bytes	Number of bytes received	integer
rx_dropped	Number of packets dropped	integer
rx_errors	Number of receive errors	integer
rx_frame	Number of framing errors	integer
rx_packets	Number of packets received	integer
source	Source of status data.	DataSourceType
tx_bytes	Number of bytes transmitted	integer
tx_carrier	Number of carrier losses detected	integer
tx_colls	Number of collisions detected	integer
tx_dropped	Number of packets dropped	integer
tx_errors	Number of transmit errors	integer
tx_packets	Number of packets transmitted	integer

Example Response:

{ "tx_errors": 0, "rx_frame": 0, "tx_carrier": 0, "tx_bytes": 31611, "rx_dropped": 1813, "tx_packets": 261, "rx_packets": 91656, "interface_id": "mgmt", "tx_dropped": 0, "tx_colls": 0, "rx_errors": 0, "rx_bytes": 7360718 }

Read the NSX Manager/Controller's Network Interface Statistics

Request:

DataSourceParameters (schema)

Example Request:

Successful Response:

NodeInterfaceStatisticsProperties (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: