List manual health checks

Query manual health checks with list parameters.

Request:

Method:

GET

URI Path(s):

/api/v1/manual-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/manual-health-checks

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

ManualHealthCheckListResult+

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	Manual Health Check List	array of ManualHealthCheck	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:

{ "sort_ascending" : true, "sort_by": "resource_type", "result_count": 2, "results": [ { "resource_type": "ManualHealthCheck", "id": "516ea614-6692-4dcb-9fa7-8304f9765a7f", "display_name": "health check 001", "operation_status": "IN PROGRESS", "transport_zone_id": "7f5e6a44-696d-401d-936a-d7138476acd3", "vlans":{ "vlan_ranges":[{ "start": 1, "end": 2 },{ "start": 4, "end": 5 }] }, "_protection" : "NOT_PROTECTED", "_create_user" : "admin", "_create_time" : 1507687895605, "_last_modified_user" : "admin", "_last_modified_time" : 1507705866588, "_system_owned" : false, "_revision" : 1 }, { "resource_type": "ManualHealthCheck", "id": "7e5d3a8c-8aa8-4df6-9a0f-b0456575b233", "display_name": "Manual Health Check 002", "operation_status": "IN PROGRESS", "transport_zone_id": "7f5e6a44-696d-401d-936a-d7138476acd3", "vlans":{ "vlan_ranges":[{ "start": 1, "end": 5 },{ "start": 11, "end": 11 }] }, "_protection": "NOT_PROTECTED", "_create_user": "admin", "_create_time": 1507687895605, "_last_modified_user": "admin", "_last_modified_time": 1507705866588, "_system_owned": false, "_revision": 0 } ] }

List manual health checks

Request:

ListRequestParameters (schema)

Example Request:

Successful Response:

ManualHealthCheckListResult (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: