IMPORTANT: No additional bug fixes or documentation updates
will be released for this version. For the latest information, see the
current release documentation.
Get Snapshot Lifecycle Management status API
editGet Snapshot Lifecycle Management status API
editRetrieves the current Snapshot Lifecycle Management (SLM) status.
Request
editGET /_slm/status
Description
editReturns the status of the SLM plugin. The operation_mode field in the
response shows one of three states: STARTED, STOPPING,
or STOPPED. You can change the status of the SLM plugin with the
Start SLM and Stop SLM APIs.
Request Parameters
edit-
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.
Authorization
editYou must have the manage_slm or read_slm or both cluster privileges to use this API.
For more information, see Security privileges.
Examples
editGets the SLM plugin status.
GET _slm/status
If the request succeeds, the body of the response shows the operation mode:
{
"operation_mode": "RUNNING"
}