Get policy Tunnel statistics summary for given tunnel-id

Get policy Tunnel statistics summary for given tunnel-id This API is only available when using VMware NSX.

Request:

Method:

GET

URI Path(s):

/policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-svc-id}/tunnels/{tunnel-id}/statistics/summary

Request Headers:

n/a

Query Parameters:

BaseListRequestParameters+

Name	Description	Type	Notes
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
enforcement_point_path	Enforcement point path String Path of the enforcement point. When not specified, routes from all enforcement-points are returned. This property is required for retrieving routes in CSV format.	string
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

Request Body:

n/a

Example Request:

GET https://<policy-mgr>/policy/api/v1/infra/tier-0s//locale-services//tunnels//statistics/summary

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

AggregateTunnelTrafficStatistics+

Name	Description	Type	Notes
resource_type	Indicates Resource type of tunnel GreTunnelAggregateTrafficStatistics - Resource type as GreTunnelAggregateTrafficStatistics will be used to populate P2P GRE Aggregate Tunnel traffic statistics	string	Required Enum: GreTunnelAggregateTrafficStatistics

Example Response:

{ "destination": "44.44.44.10", "tunnel_policy_path": "/infra/tier-0s/Tier0-LR1-AA/locale-services/T0-LR1-LocaleService-1/tunnels/aa-gre-1", "traffic_summary": { "last_update_timestamp": 1689829077378, "rx": { "total_bytes": 1347854, "total_packets": 25286, "dropped_packets": 0, "blocked_packets": 0, "destination_unsupported_dropped_packets": 0, "firewall_dropped_packets": 0, "ipsec_dropped_packets": 0, "ipsec_no_sa_dropped_packets": 0, "ipsec_no_vti_dropped_packets": 0, "ipv6_dropped_packets": 0, "kni_dropped_packets": 0, "l4port_unsupported_dropped_packets": 0, "malformed_dropped_packets": 0, "no_receiver_dropped_packets": 0, "no_route_dropped_packets": 0, "proto_unsupported_dropped_packets": 0, "redirect_dropped_packets": 0, "rpf_check_dropped_packets": 0, "ttl_exceeded_dropped_packets": 0 }, "tx": { "total_bytes": 889401, "total_packets": 17029, "dropped_packets": 0, "blocked_packets": 0, "firewall_dropped_packets": 0, "ipsec_dropped_packets": 0, "ipsec_no_sa_dropped_packets": 0, "ipsec_no_vti_dropped_packets": 0, "dad_dropped_packets": 0, "frag_needed_dropped_packets": 0, "ipsec_pol_block_dropped_packets": 0, "ipsec_pol_err_dropped_packets": 0, "no_arp_dropped_packets": 0, "no_linked_dropped_packets": 0, "no_mem_dropped_packets": 0, "non_ip_dropped_packets": 0, "service_insert_dropped_packets": 0 } }, "resource_type": "TUNNEL" }

Get policy Tunnel statistics summary for given tunnel-id

Request:

BaseListRequestParameters (schema)

Example Request:

Successful Response:

AggregateTunnelTrafficStatistics (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: