1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677 |
- [[delete-shutdown]]
- === Delete shutdown API
- NOTE: {cloud-only}
- Cancels shutdown preparations or clears a shutdown request
- so a node can resume normal operations.
- [[delete-shutdown-api-request]]
- ==== {api-request-title}
- `DELETE _nodes/<node-id>/shutdown`
- [[delete-shutdown-api-prereqs]]
- ==== {api-prereq-title}
- * If the {es} {security-features} are enabled, you must have the `manage`
- <<privileges-list-cluster,cluster privilege>> to use this API.
- * If the <<operator-privileges,{operator-feature}>> is enabled,
- you must be an operator to use this API.
- [[delete-shutdown-api-desc]]
- ==== {api-description-title}
- Enables a node to resume normal operations following a
- <<put-shutdown, put shutdown>> request.
- You must explicitly clear the shutdown request when a node rejoins the cluster,
- regardless of the shutdown type.
- [[delete-shutdown-api-path-params]]
- ==== {api-path-parms-title}
- `<node-id>`::
- (Optional, string)
- The ID of a node that you prepared for shut down.
- [[delete-shutdown-api-params]]
- ==== {api-query-parms-title}
- include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
- [[delete-shutdown-api-example]]
- ==== {api-examples-title}
- Prepare a node to be restarted:
- [source,console]
- --------------------------------------------------
- PUT /_nodes/USpTGYaBSIKbgSUJR2Z9lg/shutdown
- {
- "type": "restart",
- "reason": "Demonstrating how the node shutdown API works"
- }
- --------------------------------------------------
- // TEST[setup:node]
- // TEST[s/USpTGYaBSIKbgSUJR2Z9lg/\$node_name/]
- Cancel the shutdown preparations or clear the shutdown request
- after restarting:
- [source,console]
- --------------------------------------------------
- DELETE /_nodes/USpTGYaBSIKbgSUJR2Z9lg/shutdown
- --------------------------------------------------
- // TEST[continued]
- // TEST[s/USpTGYaBSIKbgSUJR2Z9lg/\$node_name/]
- Which returns the following response:
- [source,console-result]
- --------------------------------------------------
- {
- "acknowledged": true
- }
- --------------------------------------------------
|