Purpose

Performs a health check on the node or nodes running the data access service. Permits the configuration of a load balancer to perform periodic health checks on cluster nodes. If the service is running as expected, the status code 200 and the status message active are returned. Other responses should be investigated.

URL

https://<myserver>:<port>/api/healthcheck

Method

GET

URL Parameters

<myserver> is the hostname or IP address of the machine hosting the Hybrid Data Pipeline server for a non-load balancer deployment, or the machine hosting the load balancer for a load balancer deployment. For a non-load balancer deployment, <port> is the port number specified as the Server Access Port during deployment. For a load balancer deployment, <port> must be either 80 for http or 443 for https. Whenever port 80 or 443 are used, it is not necessary to include the port number in the URL.

Response Definition

The response takes the following format. The parameters of the response are described in the table that follows.

{
   "status": "<status>"
}
Property Description Valid Values
"status" The status of the specified node The value active indicates that the node is running as expected. Other responses should be investigated.

Sample Server Success Response 


   Status code: 200
   Successful response


{
   "status": active
}

Sample Server Failure Response

If no response is returned, the operation will time out.

Failed connect to 172.29.37.229:8443; Connection timed out.

Authentication

This endpoint is accessible to any user. Does not require authentication.

Authorization

Any active Hybrid Data Pipeline user.