Node master healthcheck requests
REST API requests to check a node's connection to the cluster's primary node.
| Redis Enterprise Software |
|---|
| Method | Path | Description |
|---|---|---|
| GET | /v1/local/node/master_healthcheck |
Checks a node's connection to the primary node |
Get master healthcheck
GET /v1/local/node/master_healthcheck
Checks whether the current node has a valid connection to the cluster's primary node and the Cluster Configuration Store (CCS).
Required permissions
| Permission name | Roles |
|---|---|
| view_cluster_info | admin cluster_member cluster_viewer db_member db_viewer user_manager |
Request
Example HTTP request
GET /v1/local/node/master_healthcheck
Headers
| Key | Value | Description |
|---|---|---|
| Host | cnm.cluster.fqdn | Domain name |
| Accept | application/json | Accepted media type |
Response
Returns a JSON object that includes the status of the current node's connection to the cluster's primary node and the CCS.
-
active: the current node has a valid connection. -
inactive: the current node doesn't have a valid connection.
Example JSON response body
{
"status": "active"
}
Status codes
| Code | Description |
|---|---|
| 200 OK | No error |