Get index lifecycle management status APIedit
Retrieves the current index lifecycle management (ILM) status.
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.
Descriptionedit
Returns the status of the ILM plugin. The operation_mode field in the
response shows one of three states: STARTED, STOPPING,
or STOPPED. You can change the status of the ILM plugin with the
start ILM and stop ILM APIs.
Query parametersedit
timeout- (Optional, time units) Specifies the period of time to wait for
a response. If no response is received before the timeout expires, the request
fails and returns an error. Defaults to
30s. master_timeout- (Optional, time units) Specifies the period of time 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.
Examplesedit
The following example gets the ILM plugin status.
GET _ilm/status
If the request succeeds, the body of the response shows the operation mode:
{
"operation_mode": "RUNNING"
}