From 1c62c8b027c9cdbedc84f23dd091fe626f31111d Mon Sep 17 00:00:00 2001 From: Rachel Elledge Date: Fri, 6 Sep 2024 16:04:13 -0500 Subject: [PATCH 1/2] DOC-4216 RS: Add maintenance_snapshot to /nodes/status REST API reference --- .../rest-api/requests/nodes/status.md | 46 ++++++++++++++++--- 1 file changed, 40 insertions(+), 6 deletions(-) diff --git a/content/operate/rs/references/rest-api/requests/nodes/status.md b/content/operate/rs/references/rest-api/requests/nodes/status.md index 50956ea4e9..414bea1e70 100644 --- a/content/operate/rs/references/rest-api/requests/nodes/status.md +++ b/content/operate/rs/references/rest-api/requests/nodes/status.md @@ -48,23 +48,41 @@ Gets the status of all nodes. Includes each node's hostname and role in the clus ### Response {#get-all-response} -For each node in the cluster, returns a JSON object that contains the node's hostname and role. +For each node in the cluster, returns a JSON object that contains each node's hostname, role, and other status details. If a maintenance snapshot exists, the response includes a `maintenance_snapshot` field. #### Example JSON body ```json { "1": { + "cores": 8, + "free_provisional_ram": 0, + "free_ram": 3499368448, "hostname": "3d99db1fdf4b", - "role": "master" + "maintenance_snapshot": { + "created_time": "2024-09-06 20:47:23", + "name": "maintenance_mode_2024-09-06_20-47-23", + "node_uid": "1" + }, + "master_shards": [], + "node_overbooking_depth": 0, + "node_status": "active", + "role": "master", + "slave_shards": [], + "software_version": "7.4.6-22", + "software_version_sha": "6c37b1483b5fb6110c8055c1526aa58eec1d29d3519e92310859101419248831", + "total_memory": 6219673600, + "total_provisional_ram": 0 }, "2": { "hostname": "fc7a3d332458", - "role": "slave" + "role": "slave", + // additional fields }, "3": { "hostname": "b87cc06c830f", - "role": "slave" + "role": "slave", + // additional fields } } ``` @@ -116,14 +134,30 @@ Gets the status of a node. Includes the node's hostname and role in the cluster: ### Response {#get-response} -Returns a JSON object that contains the node's hostname and role. +Returns a JSON object that contains the node's hostname, role, and other status details. If a maintenance snapshot exists, the response includes a `maintenance_snapshot` field. #### Example JSON body ```json { + "cores": 8, + "free_provisional_ram": 0, + "free_ram": 3504422912, "hostname": "3d99db1fdf4b", - "role": "master" + "maintenance_snapshot": { + "created_time": "2024-09-06 20:47:23", + "name": "maintenance_mode_2024-09-06_20-47-23", + "node_uid": "1" + }, + "master_shards": [], + "node_overbooking_depth": 0, + "node_status": "active", + "role": "master", + "slave_shards": [], + "software_version": "7.4.6-22", + "software_version_sha": "6c37b1483b5fb6110c8055c1526aa58eec1d29d3519e92310859101419248831", + "total_memory": 6219673600, + "total_provisional_ram": 0 } ``` From a0fc33755ab298b45af820f80af7d8d4a1bd7bf9 Mon Sep 17 00:00:00 2001 From: Rachel Elledge Date: Mon, 9 Sep 2024 17:00:49 -0500 Subject: [PATCH 2/2] git status --- .../rs/references/rest-api/requests/nodes/status.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/content/operate/rs/references/rest-api/requests/nodes/status.md b/content/operate/rs/references/rest-api/requests/nodes/status.md index 414bea1e70..e7db1e1fc2 100644 --- a/content/operate/rs/references/rest-api/requests/nodes/status.md +++ b/content/operate/rs/references/rest-api/requests/nodes/status.md @@ -48,7 +48,9 @@ Gets the status of all nodes. Includes each node's hostname and role in the clus ### Response {#get-all-response} -For each node in the cluster, returns a JSON object that contains each node's hostname, role, and other status details. If a maintenance snapshot exists, the response includes a `maintenance_snapshot` field. +For each node in the cluster, returns a JSON object that contains each node's hostname, role, and other status details. + +If a maintenance snapshot exists due to an in-progress or improperly stopped [node maintenance]({{}}) process, the response includes a `maintenance_snapshot` field. #### Example JSON body @@ -134,7 +136,9 @@ Gets the status of a node. Includes the node's hostname and role in the cluster: ### Response {#get-response} -Returns a JSON object that contains the node's hostname, role, and other status details. If a maintenance snapshot exists, the response includes a `maintenance_snapshot` field. +Returns a JSON object that contains the node's hostname, role, and other status details. + +If a maintenance snapshot exists due to an in-progress or improperly stopped [node maintenance]({{}}) process, the response includes a `maintenance_snapshot` field. #### Example JSON body