NSX-T Data Center REST API

Get segment statistics information

Get tier1 segment statistics information.

Request:

Method:

GET

URI Path(s):

/policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segments-id}/statistics
/policy/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segments-id}/statistics
/policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segments-id}/statistics

Request Headers:

n/a

Query Parameters:

L2L3RuntimeRequestParameters+

L2L3RuntimeRequestParameters (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.	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
source	Source of statistics data The data source can be either realtime or cached. If not provided, cached data is returned.	DataSourceType
stats_type	Segment statistics type This indicates the type of statistics being requested. We support statistics from the data plane.	string	Enum: DATAPATH_STATS
transport_node_id	Transport Node Id Identifer of the transport node. This is a UUID.	string

Request Body:

n/a

Example Request:

GET https://<policy-mgr>/policy/api/v1/infra/tier-1s/it_t1/segments/it-t1-seg/statistics?enforcement_point_path=/infra/sites/default/enforcement-points/default

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

SegmentStatistics+

SegmentStatistics (schema)

Name	Description	Type	Notes
dropped_by_firewall_packets		DfwDropCounters	Readonly
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_switch_id	The id of the logical Switch	string	Required Readonly
mac_learning		MacLearningCounters	Readonly
nsxt_swsec	Switch Security provides stateless L2 and L3 security by checking, traffic to the logical switch and dropping unauthorized packets sent, from VMs	SwsecCounters	Readonly
nsxt_vdl2	Overlay Layer-2 module responsible for workload connectivity	Vdl2Counters	Readonly
nsxt_vdrb	Virtual Distributed Routing (VDR) routes packets on every ESX	VdrbCounters	Readonly
rx_bytes		DataCounter	Readonly
rx_packets		DataCounter	Readonly
tx_bytes		DataCounter	Readonly
tx_packets		DataCounter	Readonly

Example Response:

{ "rx_packets": { "multicast_broadcast": 19914, "dropped": 2358, "total": 28909 }, "rx_bytes": { "multicast_broadcast": 1692690, "dropped": 0, "total": 3692670 }, "tx_packets": { "multicast_broadcast": 19914, "dropped": 0, "total": 28968 }, "tx_bytes": { "multicast_broadcast": 1493550, "dropped": 0, "total": 2853978 }, "dropped_by_security_packets": { "spoof_guard_dropped": [ { "packet_type": "IPV4", "counter": 0 }, { "packet_type": "IPV6", "counter": 0 }, { "packet_type": "ARP", "counter": 0 }, { "packet_type": "ND", "counter": 0 }, { "packet_type": "NON_IP", "counter": 0 } ], "bpdu_filter_dropped": 0, "dhcp_server_dropped_ipv4": 0, "dhcp_server_dropped_ipv6": 0, "dhcp_client_dropped_ipv4": 0, "dhcp_client_dropped_ipv6": 0 }, "mac_learning": { "mac_not_learned_packets_allowed": 0, "mac_not_learned_packets_dropped": 0, "macs_learned": 0 }, "logical_switch_id": "3df039b1-d031-4733-987f-fcf8a4ed3e5b", "last_update_timestamp": 1548964636611 }