mirror of
https://github.com/elastic/elasticsearch.git
synced 2025-06-28 17:34:17 -04:00
33a71e3289
* Remove `es-test-dir` book-scoped variable * Remove `plugins-examples-dir` book-scoped variable * Remove `:dependencies-dir:` and `:xes-repo-dir:` book-scoped variables - In `index.asciidoc`, two variables (`:dependencies-dir:` and `:xes-repo-dir:`) were removed. - In `sql/index.asciidoc`, the `:sql-tests:` path was updated to fuller path - In `esql/index.asciidoc`, the `:esql-tests:` path was updated idem * Replace `es-repo-dir` with `es-ref-dir` * Move `:include-xpack: true` to few files that use it, remove from index.asciidoc
49 lines
1.4 KiB
Text
49 lines
1.4 KiB
Text
[role="xpack"]
|
|
[[slm-api-stop]]
|
|
=== Stop {slm} API
|
|
|
|
[subs="attributes"]
|
|
++++
|
|
<titleabbrev>Stop {slm}</titleabbrev>
|
|
++++
|
|
|
|
Turn off {slm} ({slm-init}).
|
|
|
|
[[slm-api-stop-request]]
|
|
==== {api-request-title}
|
|
|
|
`POST /_slm/stop`
|
|
|
|
[[slm-api-stop-prereqs]]
|
|
==== {api-prereq-title}
|
|
|
|
If the {es} {security-features} are enabled, you must have the `manage_slm`
|
|
cluster privilege to use this API. For more information, see
|
|
<<security-privileges>>.
|
|
|
|
[[slm-api-stop-desc]]
|
|
==== {api-description-title}
|
|
|
|
Halts all {slm} ({slm-init}) operations and stops the {slm-init} plugin.
|
|
This is useful when you are performing maintenance on a cluster and need to
|
|
prevent {slm-init} from performing any actions on your data streams or indices.
|
|
Stopping {slm-init} does not stop any snapshots that are in progress.
|
|
You can manually trigger snapshots with the <<slm-api-execute-lifecycle>> even if {slm-init} is stopped.
|
|
|
|
The API returns a response as soon as the request is acknowledged, but
|
|
the plugin might continue to run until in-progress operations complete and it can be safely stopped.
|
|
|
|
Use the <<slm-api-get-status>> to see if {slm-init} is running.
|
|
|
|
==== {api-query-parms-title}
|
|
|
|
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
|
|
|
|
[[slm-api-stop-example]]
|
|
==== {api-examples-title}
|
|
|
|
|
|
[source,console]
|
|
--------------------------------------------------
|
|
POST _slm/stop
|
|
--------------------------------------------------
|