10
10
11
11
Retrieves the current {ilm} ({ilm-init}) status.
12
12
13
+ You can start or stop {ilm-init} with the <<ilm-start,start {ilm-init}>> and
14
+ <<ilm-stop,stop {ilm-init}>> APIs.
15
+
13
16
[[ilm-get-status-request]]
14
17
==== {api-request-title}
15
18
@@ -22,20 +25,33 @@ Retrieves the current {ilm} ({ilm-init}) status.
22
25
`read_ilm` or both cluster privileges to use this API. For more information, see
23
26
<<security-privileges>>.
24
27
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
-
34
28
[[ilm-get-status-query-params]]
35
29
==== {api-query-parms-title}
36
30
37
31
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
38
32
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
+
39
55
[[ilm-get-status-example]]
40
56
==== {api-examples-title}
41
57
0 commit comments