Show the details of latency status for all appliances

Show the details of latency status in all appliances.

Request:

Method:

GET

URI Path(s):

/api/v1/systemhealth/appliances/latency/status

Request Headers:

n/a

Query Parameters:

ListRequestParameters+

Name	Description	Type	Notes
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
included_fields	Comma separated list of fields that should be included in query result	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://<nsx-mgr>/api/v1/systemhealth/appliances/latency/status

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

ApplianceLatencyListResult+

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Total appliance latency count	integer	Required
results	Appliance Process List Display the appliance latency data list.	array of ApplianceLatencyData
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

Example Response:

{ "result_count": 3, "results": [ { "id": "72e1bd4b-6df6-42d0-9c59-a1c31312c9f1", "name": "nsxmanager-15702468-1", "latency_data": [ { "source_node_ip": "10.92.111.33", "destination_node_id": "22e1bd4b-6df6-42d0-9c59-a1c31312c9f1", "destination_node_name": "nsxmanager-15702468-2", "destination_node_ip": "10.92.111.34", "rtt_min": 0.180, "rtt_avg": 0.396, "rtt_max": 1.003, "rtt_mdev": 0.350, "status": "UP", "packet_transmitted": 4, "packet_received": 4, "packet_loss_percent": "0%", "total_time": 3049, }, { "source_node_ip": "10.92.111.33", "destination_node_id": "42e1bd4b-6df6-42d0-9c59-a1c31312c9f1", "destination_node_name": "nsxmanager-15702468-3", "destination_node_ip": "10.92.111.35", "rtt_min": 0.180, "rtt_avg": 0.396, "rtt_max": 1.003, "rtt_mdev": 0.350, "status": "UP", "packet_transmitted": 4, "packet_received": 4, "packet_loss_percent": "0%", "total_time": 3049, } ] }, { "id": "22e1bd4b-6df6-42d0-9c59-a1c31312c9f1", "name": "nsxmanager-15702468-2", "latency_data": [ { "source_node_ip": "10.92.111.34", "destination_node_id": "72e1bd4b-6df6-42d0-9c59-a1c31312c9f1", "destination_node_name": "nsxmanager-15702468-1", "destination_node_ip": "10.92.111.33", "rtt_min": 0.180, "rtt_avg": 0.396, "rtt_max": 1.003, "rtt_mdev": 0.350, "status": "UP", "packet_transmitted": 4, "packet_received": 4, "packet_loss_percent": "0%", "total_time": 3049, }, { "source_node_ip": "10.92.111.34", "destination_node_id": "42e1bd4b-6df6-42d0-9c59-a1c31312c9f1", "destination_node_name": "nsxmanager-15702468-3", "destination_node_ip": "10.92.111.35", "rtt_min": 0.180, "rtt_avg": 0.396, "rtt_max": 1.003, "rtt_mdev": 0.350, "status": "UP", "packet_transmitted": 4, "packet_received": 4, "packet_loss_percent": "0%", "total_time": 3049, } ] }, { "id": "42e1bd4b-6df6-42d0-9c59-a1c31312c9f1", "name": "nsxmanager-15702468-3", "latency_data": [ { "source_node_ip": "10.92.111.35", "destination_node_id": "72e1bd4b-6df6-42d0-9c59-a1c31312c9f1", "destination_node_name": "nsxmanager-15702468-1", "destination_node_ip": "10.92.111.33", "rtt_min": 0.180, "rtt_avg": 0.396, "rtt_max": 1.003, "rtt_mdev": 0.350, "status": "UP", "packet_transmitted": 4, "packet_received": 4, "packet_loss_percent": "0%", "total_time": 3049, }, { "source_node_ip": "10.92.111.35", "destination_node_id": "22e1bd4b-6df6-42d0-9c59-a1c31312c9f1", "destination_node_name": "nsxmanager-15702468-2", "destination_node_ip": "10.92.111.34", "rtt_min": 0.180, "rtt_avg": 0.396, "rtt_max": 1.003, "rtt_mdev": 0.350, "status": "UP", "packet_transmitted": 4, "packet_received": 4, "packet_loss_percent": "0%", "total_time": 3049, } ] } ] }

Show the details of latency status for all appliances

Request:

ListRequestParameters (schema)

Example Request:

Successful Response:

ApplianceLatencyListResult (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: