Cumulative statistics for one IKE service instance

Cumulative statistics for one IKE service instance. Query parameter source supports only cached mode.

Request:

Method:

GET

URI Path(s):

/api/v1/vpn/services/<service-id>/summary

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/vpn/services/f962173f-ac03-4d08-8366-56a41779f61d/summary?source=cached

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

IPSecVPNIKEServiceSummary+

Name	Description	Type	Notes
aggregate_traffic_counters	Traffic summary Aggregate traffic statistics across all selected sessions.	IPSecVPNTrafficCounters
display_name	Display name VPN service display name.	string	Readonly
ipsec_vpn_service_id	Service identifier UUID for a vpn service.	string	Readonly
last_update_timestamp	Last updated timestamp Timestamp when the data was last updated.	EpochMsTimestamp	Readonly
logical_router_id	Logical router identifier Logical router identifier associated with vpn service.	string	Readonly
session_summary	Session summary Session summary for number of total, established, failed and degraded IPSec VPN sessions.	IPsecVPNIKESessionSummary	Readonly
traffic_summary_per_session	Traffic summary Traffic summary per session.	array of IPSecVPNSessionTrafficSummary

Example Response:

{ "ipsec_vpn_service_id": "f962173f-ac03-4d08-8366-56a41779f61d", "display_name": "VPN Service", "logical_router_id": "efe62173f-ac03-4d08-8366-56a41779f61d", "ike_summary": "{ "established_ike_sessions": "100", "failed_ike_sessions": "["401","404"]", "total_ike_sessions": "200" }", "traffic_summary_per_session": "[{ "traffic_stats": "{ "packets_in": "100", "packets_out": "77", "bytes_in": "1000", "bytes_out": "830", "dropped_packets": "23" }", "ipsec_vpn_session": "{ "target_display_name": "4630aadd-25d7-4c73-b03c-227ac314dfc4", "is_valid": true, "target_type": "LogicalRouter", "target_id": "4630aadd-25d7-4c73-b03c-227ac314dfc4" }", }]", "aggregate_traffic_counters": "{ "packets_in": "100", "packets_out": "77", "bytes_in": "1000", "bytes_out": "830", "dropped_packets": "23" }", "last_update_timestamp": "1000" }

Cumulative statistics for one IKE service instance

Request:

DataSourceParameters (schema)

Example Request:

Successful Response:

IPSecVPNIKEServiceSummary (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: