Get the shutdown status

GET /_nodes/{node_id}/shutdown
GET /_nodes/shutdown

Get information about nodes that are ready to be shut down, have shut down preparations still in progress, or have stalled. The API returns status information for each part of the shut down process.

NOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported.

If the operator privileges feature is enabled, you must be an operator to use this API.

Path Parameters

node_id union NodeId | [] NodeId optional

Comma-separated list of nodes for which to retrieve the shutdown status

Leave it out to use /_nodes/shutdown.

Query Parameters

master_timeout string Duration · default: 30s: Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

Get the status of shutdown preparations with GET /_nodes/USpTGYaBSIKbgSUJR2Z9lg/shutdown. The response shows information about the shutdown preparations, including the status of shard migration, task migration, and plugin cleanup

Request Console 1 / 7 languages

Console Kibana Dev Tools

GET /_nodes/USpTGYaBSIKbgSUJR2Z9lg/shutdown

JavaScript Elasticsearch JavaScript Client

const response = await client.shutdown.getNode({
  node_id: "USpTGYaBSIKbgSUJR2Z9lg",
});

Python Elasticsearch Python Client

resp = client.shutdown.get_node(
    node_id="USpTGYaBSIKbgSUJR2Z9lg",
)

curl Shell

curl -X GET "$ELASTICSEARCH_URL/_nodes/USpTGYaBSIKbgSUJR2Z9lg/shutdown" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.shutdown().getNode(g -> g
    .nodeId("USpTGYaBSIKbgSUJR2Z9lg")
);

PHP Elasticsearch PHP Client

$resp = $client->shutdown()->getNode([
    "node_id" => "USpTGYaBSIKbgSUJR2Z9lg",
]);

Ruby Elasticsearch Ruby Client

response = client.perform_request(
  "GET",
  "/_nodes/USpTGYaBSIKbgSUJR2Z9lg/shutdown",
  {},
)

Response

{
    "nodes": [
        {
            "node_id": "USpTGYaBSIKbgSUJR2Z9lg",
            "type": "RESTART",
            "reason": "Demonstrating how the node shutdown API works",
            "shutdown_startedmillis": 1624406108685,
            "allocation_delay": "10m",
            "status": "COMPLETE",
            "shard_migration": {
                "status": "COMPLETE",
                "shard_migrations_remaining": 0,
                "explanation": "no shard relocation is necessary for a node restart"
            },
            "persistent_tasks": {
                "status": "COMPLETE"
            },
            "plugins": {
                "status": "COMPLETE"
            }
        }
    ]
}

Required authorization

Path Parameters

Query Parameters

Response