Getting Heart Beat information

For every object in GET /api/v1/object/{object_id}/ you could get information about status of the components on hosts.

This information is just a Heart Beat of systemd-service or docker-container running in cluster.

Heart Beat for Components

GET /status/api/v1/cluster/{cluster_id}/service/{service_id}/component/{component_id}/

Parameter Type
status integer

Possible values of the status:

Value Meaning
0 Service or container is up and running according to OS information on all nodes
<any> Service or container is not up and running according to OS information on some of the nodes

Heart Beat for Service

Status for service is an aggregation of component’s status. So it is not mandatory to care about this endpoint if you get everything about components to your monitoring system.

GET /status/api/v1/cluster/{cluster_id}/service/{service_id}/

Parameter Type
status integer

Possible values of the status:

Value Meaning
0 All components in service have no problems
<any> At least one component has a problem on some host

Heart Beat for Cluster

Status of cluster is an aggregation of service’s status. There is no need to care about this if you already have information about services or components in your monitoring system.

GET /status/api/v1/cluster/{cluster_id}/

Parameter Type
status integer

Possible values of the status:

Value Meaning
0 All services in cluster have no problems
<any> At least one service has some problem