Sign in

v1

latestOpenAPI 3.1.0AGPL-3.02026-07-1249126143.7 KB
Cluster

Returns the global status of the cluster, the number of connected nodes (over the number of known ones), the number of healthy storage nodes (over the declared ones), and the number of healthy partitions (over the total).

get/v2/GetClusterHealth

Response

Cluster health report

connectedNodesinteger required

the number of nodes this Garage node currently has an open connection to

knownNodesinteger required

the number of nodes this Garage node has had a TCP connection to since the daemon started

partitionsinteger required

the total number of partitions of the data (currently always 256)

partitionsAllOkinteger required

the number of partitions for which we are connected to all storage nodes responsible of storing it

partitionsQuoruminteger required

the number of partitions for which a quorum of write nodes is available

statusstring required

One of healthy, degraded or unavailable:

  • healthy: Garage node is connected to all storage nodes
  • degraded: Garage node is not connected to all storage nodes, but a quorum of write nodes is available for all partitions
  • unavailable: a quorum of write nodes is not available for some partitions
storageNodesinteger required

the number of storage nodes currently registered in the cluster layout

storageNodesUpinteger required

the number of storage nodes to which a connection is currently open