IMPORTANT: No additional bug fixes or documentation updates
will be released for this version. For the latest information, see the
current release documentation.
Get index lifecycle management status API
editGet index lifecycle management status API
editRetrieves the current index lifecycle management (ILM) status.
Request
editGET /_ilm/status
Description
editReturns 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.
Request Parameters
edit-
timeout -
(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. For more information about time units, see Time units. -
master_timeout -
(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. For more information about time units, see Time units.
Authorization
editYou must have the manage_ilm or read_ilm or both cluster privileges to use this API.
For more information, see Security privileges.
Examples
editThe 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"
}