Skip to content

Commit c0cfef0

Browse files
committed
Copied /node/master_healthcheck REST API reference to RS 7.8 version
1 parent 9d33377 commit c0cfef0

File tree

1 file changed

+71
-0
lines changed
  • content/operate/rs/7.8/references/rest-api/requests/node_master_healthcheck

1 file changed

+71
-0
lines changed
Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
---
2+
Title: Node master healthcheck requests
3+
alwaysopen: false
4+
categories:
5+
- docs
6+
- operate
7+
- rs
8+
description: REST API requests to check a node's connection to the cluster's primary node.
9+
headerRange: '[1-2]'
10+
hideListLinks: true
11+
linkTitle: node/master_healthcheck
12+
weight: $weight
13+
url: '/operate/rs/7.8/references/rest-api/requests/node_master_healthcheck/'
14+
---
15+
16+
| Method | Path | Description |
17+
|--------|------|-------------|
18+
| [GET](#get-node-master-healthcheck) | `/v1/local/node/master_healthcheck` | Checks a node's connection to the primary node |
19+
20+
## Get master healthcheck {#get-node-master-healthcheck}
21+
22+
```sh
23+
GET /v1/local/node/master_healthcheck
24+
```
25+
26+
Checks whether the current node has a valid connection to the cluster's primary node and the Cluster Configuration Store (CCS).
27+
28+
### Required permissions
29+
30+
| Permission name | Roles |
31+
|-----------------|-------|
32+
| [view_cluster_info]({{< relref "/operate/rs/7.8/references/rest-api/permissions#view_cluster_info" >}}) | admin<br />cluster_member<br />cluster_viewer<br />db_member<br />db_viewer<br />user_manager |
33+
34+
### Request {#get-request}
35+
36+
#### Example HTTP request
37+
38+
```sh
39+
GET /v1/local/node/master_healthcheck
40+
```
41+
42+
43+
#### Headers
44+
45+
| Key | Value | Description |
46+
|-----|-------|-------------|
47+
| Host | cnm.cluster.fqdn | Domain name |
48+
| Accept | application/json | Accepted media type |
49+
50+
51+
### Response {#get-response}
52+
53+
Returns a JSON object that includes the status of the current node's connection to the cluster's primary node and the CCS.
54+
55+
- `active`: the current node has a valid connection.
56+
57+
- `inactive`: the current node doesn't have a valid connection.
58+
59+
#### Example JSON response body
60+
61+
```json
62+
{
63+
"status": "active"
64+
}
65+
```
66+
67+
#### Status codes {#get-status-codes}
68+
69+
| Code | Description |
70+
|------|-------------|
71+
| [200 OK](https://www.rfc-editor.org/rfc/rfc9110.html#name-200-ok) | No error |

0 commit comments

Comments
 (0)