You are looking at preliminary documentation for a future release.
Not what you want? See the
current release documentation.
Get index lifecycle management status APIedit
Retrieves the current index lifecycle management (ILM) status.
You can start or stop ILM with the start ILM and stop ILM APIs.
Requestedit
GET /_ilm/status
Prerequisitesedit
-
If the Elasticsearch security features are enabled, you must have the
manage_ilmorread_ilmor both cluster privileges to use this API. For more information, see Security privileges.
Query parametersedit
-
master_timeout -
(Optional, time units)
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. Defaults to
30s. -
timeout -
(Optional, time units)
Period to wait for a response. If no response is received before the timeout
expires, the request fails and returns an error. Defaults to
30s.
Response bodyedit
-
operation_mode -
(string) Current operation mode for ILM.
Possible values for
operation_mode-
RUNNING - ILM is running.
-
STOPPING -
ILM is finishing sensitive actions, such as shrink, that
are in progress. When these actions finish, ILM will move to
STOPPED. -
STOPPED - ILM is not running.
-
Examplesedit
The following example gets the ILM plugin status.
response = client.ilm.get_status puts response
GET _ilm/status
If the request succeeds, the body of the response shows the operation mode:
{
"operation_mode": "RUNNING"
}