Query parameters

  • master_timeoutstring

    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.

    Values are nanos, micros, ms, s, m, h, or d.

Responses

  • 200 application/json
    Hide response attribute Show response attribute object
    • nodesarray[object] Required
      Hide nodes attributes Show nodes attributes object
      • node_idstring Required
      • typestring Required

        Values are remove or restart.

      • reasonstring Required
      • shutdown_startedmillisnumber

        Time unit for milliseconds

      • statusstring Required

        Values are not_started, in_progress, stalled, or complete.

      • shard_migrationobject Required
        Hide shard_migration attribute Show shard_migration attribute object
        • statusstring Required

          Values are not_started, in_progress, stalled, or complete.

      • persistent_tasksobject Required
        Hide persistent_tasks attribute Show persistent_tasks attribute object
        • statusstring Required

          Values are not_started, in_progress, stalled, or complete.

      • pluginsobject Required
        Hide plugins attribute Show plugins attribute object
        • statusstring Required

          Values are not_started, in_progress, stalled, or complete.

GET /_nodes/shutdown
curl \
 --request GET 'http://api.example.com/_nodes/shutdown' \
 --header "Authorization: $API_KEY"
Response examples (200)
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
{
    "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"
            }
        }
    ]
}