managementRoutes
managementRoutes(
system,cluster,settings?):object
Defined in: src/management/HttpManagement.ts:53
Build a Route tree exposing cluster-management HTTP endpoints. The caller binds the returned routes into their HTTP server — management usually lives on a separate port so it can be firewalled off the public one.
Endpoints:
GET /cluster/members→ current membership JSONGET /cluster/leader→ leader infoGET /cluster/shards?type=<typeName>→ shard-to-region map for one type (#56)GET /health→ liveness (200 iff all checks pass)GET /ready→ readiness (200 iff cluster is up + all checks pass)POST /cluster/leave→ graceful leave (optional, off by default)POST /cluster/downbody{address}→ force-down a peer (optional, off by default) (#56)GET /metrics→ Prometheus text format (optional, off by default) (#56)
Parameters
Section titled “Parameters”system
Section titled “system”cluster
Section titled “cluster”Cluster | null
settings?
Section titled “settings?”Returns
Section titled “Returns”object
health
Section titled “health”health:
HealthCheckRegistry
routes
Section titled “routes”routes:
Route