Get DCS cluster health
Live etcd member, quorum and dependent service health of a DCS cluster.
GET
/api/v1/dcs-clusters/{id}/healthAuthorization
tse_sessionAPI key · cookierequiredPath parameters
idstringrequiredResponses
200
OK
console_mesh_downbooleanThe console reaches no enrolled server over the mesh, so the members were not checked.
errorstringmembersDcsMemberHealth[]requiredShow propertiesHide properties
Array of
DcsMemberHealthcausestringWhy the member is not healthy: down (no mesh path), unverified (the check failed), unhealthy (etcd says so), or empty (the slot has no server; server_id is empty). Empty when healthy.
Allowed:
downunverifiedunhealthyemptydb_size_bytesinteger<int64>errorstringhealthybooleanrequiredhoststringrequiredis_leaderbooleanrequiredmember_namestringrequiredoverlay_ipstringprevious_server_idstringprevious_server_namestringraft_indexinteger<int64>min 0
raft_terminteger<int64>min 0
reachablebooleanrequiredrebuild_errorstringrequiredrebuild_pendingbooleanrequiredrebuild_statestringrequiredrunning, failed, or empty when no rebuild runs or failed
server_idstringrequiredserver_namestringrequiredversionstringquorumDcsQuorumrequiredShow propertiesHide properties
at_riskbooleanrequiredhealthyinteger<int64>requiredneededinteger<int64>requiredsizeinteger<int64>requiredservicesDcsDependentService[]requiredShow propertiesHide properties
Array of
DcsDependentServiceidstringrequirednamestringrequiredstatusstringrequiredstatusstringrequiredAllowed:
healthydegradedunhealthydefault
Error
codestringStable code of the refusal, when the route has codes
detailsstring[]Additional detail, e.g. per-field validation failures
errorstringrequiredHuman-readable error message