1010
1111Retrieves the current {ilm} ({ilm-init}) status.
1212
13+ You can start or stop {ilm-init} with the <<ilm-start,start {ilm-init}>> and
14+ <<ilm-stop,stop {ilm-init}>> APIs.
15+
1316[[ilm-get-status-request]]
1417==== {api-request-title}
1518
@@ -22,20 +25,33 @@ Retrieves the current {ilm} ({ilm-init}) status.
2225`read_ilm` or both cluster privileges to use this API. For more information, see
2326<<security-privileges>>.
2427
25- [[ilm-get-status-desc]]
26- ==== {api-description-title}
27-
28- [[ilm-operating-modes]]
29- Returns the status of the {ilm-init} plugin.
30- The `operation_mode` in the response shows one of three states: `STARTED`, `STOPPING`, or `STOPPED`.
31- You can start or stop {ilm-init} with the
32- <<ilm-start,start {ilm-init}>> and <<ilm-stop,stop {ilm-init}>> APIs.
33-
3428[[ilm-get-status-query-params]]
3529==== {api-query-parms-title}
3630
3731include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
3832
33+ [role="child_attributes"]
34+ [[ilm-get-status-response-body]]
35+ ==== {api-response-body-title}
36+
37+ [[ilm-operating-modes]]
38+ `operation_mode`::
39+ (string) Current operation mode for {ilm-init}.
40+ +
41+ .Possible values for `operation_mode`
42+ [%collapsible%open]
43+ ====
44+ `RUNNING`::
45+ {ilm-init} is running.
46+
47+ `STOPPING`::
48+ {ilm-init} is finishing sensitive actions, such as <<ilm-shrink,shrink>>, that
49+ are in progress. When these actions finish, {ilm-init} will move to `STOPPED`.
50+
51+ `STOPPED`::
52+ {ilm-init} is not running.
53+ ====
54+
3955[[ilm-get-status-example]]
4056==== {api-examples-title}
4157
0 commit comments