Developer Documentation
Get Segment Port Statistics
Get infra segment port statistics information
Request
URLURL
https://nsxmanager.your.domain/policy/api/v1/infra/segments/{segments-id}/ports/{port-id}/statistics
Path Parameters
Path Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | Not available |
| required |
|
string | Not available |
Query Parameters
Query Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| optional |
|
string | Opaque cursor to be used for getting next page of records (supplied by current result page) |
| optional |
|
string | Policy path of edge node |
| optional |
|
string | String Path of the enforcement point |
| optional |
|
boolean | Include objects that are marked for deletion in results |
| optional |
|
string | Comma separated list of fields that should be included in query result |
| optional |
|
integer | Maximum number of results to return in this page (server may return fewer) |
| optional |
|
boolean | Not available |
| optional |
|
string | Field by which records are sorted |
Response
Response
Response BodyResponse Body
200 OK returns
SegmentPortStatistics
{
"dropped_by_security_packets": {
"bpdu_filter_dropped": 0,
"dhcp_client_dropped_ipv4": 0,
"dhcp_client_dropped_ipv6": 0,
"dhcp_server_dropped_ipv4": 0,
"dhcp_server_dropped_ipv6": 0,
"spoof_guard_dropped": [
{
"counter": 0,
"packet_type": "string"
}
]
},
"last_update_timestamp": 0,
"logical_port_id": "string",
"mac_learning": {
"mac_not_learned_packets_allowed": 0,
"mac_not_learned_packets_dropped": 0,
"macs_learned": 0
},
"rx_bytes": {
"dropped": 0,
"multicast_broadcast": 0,
"total": 0
},
"rx_packets": {
"dropped": 0,
"multicast_broadcast": 0,
"total": 0
},
"tx_bytes": {
"dropped": 0,
"multicast_broadcast": 0,
"total": 0
},
"tx_packets": {
"dropped": 0,
"multicast_broadcast": 0,
"total": 0
}
}| Property Name | Type | Description |
|---|---|---|
| dropped_by_security_packets | PacketsDroppedBySecurity | Not available |
| last_update_timestamp | integer |
Timestamp when the data was last updated; unset if data source has never updated the data. |
| logical_port_id | string |
The id of the logical port |
| mac_learning | MacLearningCounters | Not available |
| rx_bytes | DataCounter | Not available |
| rx_packets | DataCounter | Not available |
| tx_bytes | DataCounter | Not available |
| tx_packets | DataCounter | Not available |
Errors
| Code | Returns | Description |
|---|---|---|
| 503 | ServiceUnavailable | The server is currently unavailable (because it is overloaded or down for maintenance). |
| 400 | BadRequest | The request cannot be fulfilled due to bad syntax. |
| 403 | Forbidden | The server understood the request, but is refusing to fulfill it. |
| 404 | Nothing | Not Found |
| 412 | PreconditionFailed | Not available |
| 500 | InternalServerError | The server encountered an unexpected condition which prevented it from fulfilling the request. |
On This Page
Segments Operations
put
delete
delete
delete
delete
delete
delete
get
get
patch
patch
patch
patch
