Node Health

GET /health/nodes

Get all nodes health (management + agents) from database

Retrieves current health status of all nodes (management and agent nodes) from PostgreSQL

Status Codes:
Response JSON Object:

  • agent_nodes (integer)

  • average_health_percent (number)

  • management_nodes (integer)

  • nodes[].bmc_ip (string)

  • nodes[].dependencies[].error (string)

  • nodes[].dependencies[].error_count (integer)

  • nodes[].dependencies[].latency_ms (integer)

  • nodes[].dependencies[].name (string)

  • nodes[].dependencies[].services[].failed (integer)

  • nodes[].dependencies[].services[].instances[].container_id (string)

  • nodes[].dependencies[].services[].instances[].host (string)

  • nodes[].dependencies[].services[].instances[].name (string)

  • nodes[].dependencies[].services[].instances[].status (string)

  • nodes[].dependencies[].services[].running (integer)

  • nodes[].dependencies[].services[].service_type (string)

  • nodes[].dependencies[].services[].status (string)

  • nodes[].dependencies[].services[].total (integer)

  • nodes[].dependencies[].status (string)

  • nodes[].dependencies[].summary.failed (integer)

  • nodes[].dependencies[].summary.running (integer)

  • nodes[].dependencies[].summary.total (integer)

  • nodes[].dependencies[].system_vm_summary.non_running (integer)

  • nodes[].dependencies[].system_vm_summary.running (integer)

  • nodes[].dependencies[].system_vm_summary.total (integer)

  • nodes[].dependencies[].system_vms[].agent_state (string)

  • nodes[].dependencies[].system_vms[].name (string)

  • nodes[].dependencies[].system_vms[].public_ip (string)

  • nodes[].dependencies[].system_vms[].state (string) – State is the hypervisor VM state; AgentState is the CloudStack agentstate (control-plane reachability). A system VM is healthy only when BOTH are positive — see common.SystemVMHealthy (the single health authority).

  • nodes[].dependencies[].system_vms[].zone_name (string)

  • nodes[].fqdn (string)

  • nodes[].health_percentage (number)

  • nodes[].healthy_checks (integer)

  • nodes[].is_control_node (boolean)

  • nodes[].is_stale (boolean)

  • nodes[].last_updated (string)

  • nodes[].node_hostname (string)

  • nodes[].node_ip (string)

  • nodes[].node_type (string) – “management” or “agent”

  • nodes[].overall_status (string)

  • nodes[].total_checks (integer)

  • nodes[].unhealthy_checks (integer)

  • nodes[].vendor (string)

  • offline_nodes (integer)

  • online_nodes (integer)

  • stale_nodes (integer)

  • timestamp (string)

  • total_nodes (integer)

  • warning_nodes (integer)