Health Monitor:Get Health

Search (SHIFT+S)



New in this release

Get Health

GET /monitor/health

Gets health of node and its services.

Node health status: Good - when node is reachable and all its services are GOOD Unavailable - when node is not reachable Degraded - when node is reachable and any of its service is Unavailable/Degraded Node/syssvc Unavailable - when node is down or syssvc is not Unavailable on the node

Service health status: Good - when a service is up and running Unavailable - when a service is not running but is registered in coordinator Restarted - when service is restarting


Query Parameters

node_idnode ids for which health stats are collected.

Required Roles

Requires one of the following roles:

  • SYSTEM_ADMIN
  • SYSTEM_MONITOR

Response Body

Health response.

Field Description Type Notes
<health>
<node_health_list>
<node_health>     0-* Elements
<node_id> String
<status> String
<service_health_list>
<service_health>     0-* Elements
<name> String
<status> String
</service_health>      
</service_health_list>
<ip> String
</node_health>      
</node_health_list>
</health>

Examples

Request
GET https://192.168.0.0:4443/monitor/health HTTP/1.1 

Content-Type: application/xml
X-SDS-AUTH-TOKEN: <AUTH_TOKEN>
Response
HTTP/1.1 200 OK 
Content-Type: application/xml 

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<health>
  <node_health_list>
    <node_health>
      <ip>localhost</ip>
      <node_id>standalone</node_id>
      <service_health_list>
        <service_health>
          <name>apisvc</name>
          <status>Good</status>
        </service_health>
        <service_health>
          <name>authsvc</name>
          <status>Good</status>
        </service_health>
        <service_health>
          <name>controllersvc</name>
          <status>Good</status>
        </service_health>
        <service_health>
          <name>coordinatorsvc</name>
          <status>Good</status>
        </service_health>
        <service_health>
          <name>dbsvc</name>
          <status>Good</status>
        </service_health>
        <service_health>
          <name>portalsvc</name>
          <status>Good</status>
        </service_health>
        <service_health>
          <name>sasvc</name>
          <status>Good</status>
        </service_health>
        <service_health>
          <name>syssvc</name>
          <status>Good</status>
        </service_health>
        <service_health>
          <name>vasasvc</name>
          <status>Good</status>
        </service_health>
      </service_health_list>
      <status>Good</status>
    </node_health>
  </node_health_list>
</health>
Notes: