List automatic health checks

Query automatic health checks with list parameters.

Request:

Method:

GET

URI Path(s):

/api/v1/automatic-health-checks

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/automatic-health-checks

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

AutomaticHealthCheckListResult+

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	Count of results found (across all pages), set only on first page	integer	Readonly
results	Automatic Health Check List	array of AutomaticHealthCheck	Readonly
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

Example Response:

{ "results": [ { "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": 1558496244824 } }, { "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": 1558496244850 } } ], "updated_time": 1558496244850 } } ], "result_count": 1 }

List automatic health checks

Request:

ListRequestParameters (schema)

Example Request:

Successful Response:

AutomaticHealthCheckListResult (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: