Management Plane API >
Networking
>
Logical Switching
>
Logical Switch Ports
Get Statistics for Logical Port of a Given Port ID (lport-id)
Returns statistics of a specified logical port. If the logical port is attached to
a logical router port, query parameter "source=realtime" is not supported.
Request:
Method:
GET
URI Path(s):
/api/v1/logical-ports/<lport-id>/statistics
Request Headers:
n/a
Query Parameters:
DataSourceParameters
+
DataSourceParameters
(
schema
)
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/logical-ports/<lport-id>/statistics
Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
LogicalPortStatistics
+
LogicalPortStatistics
(
schema
)
Name
Description
Type
Notes
dropped_by_security_packets
PacketsDroppedBySecurity
Readonly
last_update_timestamp
Timestamp when the data was last updated; unset if data source has never updated the data.
EpochMsTimestamp
Readonly
logical_port_id
The id of the logical port
string
Required
Readonly
mac_learning
MacLearningCounters
Readonly
rx_bytes
DataCounter
Readonly
rx_packets
DataCounter
Readonly
tx_bytes
DataCounter
Readonly
tx_packets
DataCounter
Readonly
Example Response:
{ "tx_packets": { "total": 0, "dropped": 0, "multicast_broadcast": 0 }, "rx_bytes": { "total": 11473, "multicast_broadcast": 11473 }, "tx_bytes": { "total": 0, "multicast_broadcast": 0 }, "rx_packets": { "total": 56, "dropped": 0, "multicast_broadcast": 56 }, "logical_port_id": "04efc498-b872-40fc-83f8-ebf9317a2766", "last_update_timestamp": 1453500812476 }
Required Permissions:
read
Feature:
aggregation_service_health_monitoring
Additional Errors:
404 Not Found
301 Moved Permanently
307 Temporary Redirect
400 Bad Request
403 Forbidden
409 Conflict
500 Internal Server Error
503 Service Unavailable