System Administration >
Monitoring
>
Health Checks
Get an automatic health check
Get health check performed by system automatically for specific transport
zone.
Request:
Method:
GET
URI Path(s):
/api/v1/automatic-health-checks/transport-zones/<transport-zone-id>
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a
Example Request:
GET https://<nsx-mgr>/api/v1/automatic-health-checks/transport-zones/ 57430c2c-2d54-4976-811d-80f734f0acc9
Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
AutomaticHealthCheck
+
AutomaticHealthCheck
(
schema
)
Name
Description
Type
Notes
result
HealthCheckResult
Readonly
transport_zone_id
Transport Zone ID
ID of the transport zone where this automatic health check is performed.
string
Readonly
Example Response:
{ "transport_zone_id": "57430c2c-2d54-4976-811d-80f734f0acc9", "result": { "vlan_mtu_status": "TRUNKED", "results_per_transport_node": [ { "transport_node_id": "1744d346-7b75-11e9-bbd3-3325c02eb651", "result_on_host_switch": { "host_switch_name": "nsxvswitch", "results_per_uplink": [ { "uplink_name": "uplink1", "vlan_and_mtu_allowed": [ { "start": 0, "end": 0 } ], "mtu_disallowed": [], "vlan_disallowed": [] } ], "vlan_mtu_status": "TRUNKED", "updated_time": 1558496425055 } }, { "transport_node_id": "2dd19d4c-7b75-11e9-a37e-dda5bd0f9e75", "result_on_host_switch": { "host_switch_name": "nsxvswitch", "results_per_uplink": [ { "uplink_name": "uplink1", "vlan_and_mtu_allowed": [ { "start": 0, "end": 0 } ], "mtu_disallowed": [], "vlan_disallowed": [] } ], "vlan_mtu_status": "TRUNKED", "updated_time": 1558496425079 } } ], "updated_time": 1558496457663 } }
Required Permissions:
read
Feature:
tools_health_check
Additional Errors:
404 Not Found
301 Moved Permanently
307 Temporary Redirect
400 Bad Request
403 Forbidden
409 Conflict
500 Internal Server Error
503 Service Unavailable