Cluster Status

POST {{HDB_ENDPOINT}}

Returns the status of a cluster relative to the instance where the operation is executed. Learn more about HarperDB clustering here: https://harperdb.io/docs/clustering/.

Operation is restricted to superuser roles only

  • operation (required) - must always be 'clusterstatus'

Request Body

{"operation"=>"cluster_status"}

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring

RESPONSES

status: OK

{"is_enabled":true,"node_name":"compute-stack-09115d06-1608050472458","status":{"id":"2f30126f-6811-4726-9748-dc0fc109118d","type":"CLUSTER_STATUS_RESPONSE","outbound_connections":[{"id":"zZJRwGxcAtoQZcGQAAAE","host_address":"192.168.100.100","host_port":12345,"state":"open","node_name":"node2","subscriptions":[{"channel":"dev:dog","subscribe":true,"publish":true}]}],"inbound_connections":[]}}