Use the status diagnostic resource to check the health status of the service and for automatic health checks performed by a load-balancer. For example:
GET
. . /api/diagnostic/status
The status diagnostic resource works by making a Web API call to the database server and attempting to open a connection within a three second time limit.
-
Successful connection - the database server returns an HTTP 200 Status code with OK in the message body.
-
Unsuccessful connection - the database server returns an HTTP 500 status code with UNHEALTHY in the message body.
Any other response returned indicates the service is not in a healthy state. This
includes no response due to a timeout.