You are looking at preliminary documentation for a future release.
Not what you want? See the
current release documentation.
Get snapshot lifecycle management status APIedit
Retrieves the status of snapshot lifecycle management (SLM).
Requestedit
GET /_slm/status
Descriptionedit
Returns the status of the SLM plugin.
The operation_mode
field in the response shows one of three states:
RUNNING
, STOPPING
, or STOPPED
.
You halt and restart the SLM plugin with the
stop and start APIs.
Query parametersedit
-
master_timeout
-
(Optional, time units)
Period to wait for the master node. If the master node is not available before
the timeout expires, the request fails and returns an error. Defaults to
30s
. Can also be set to-1
to indicate that the request should never timeout. -
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
.
Prerequisitesedit
If the Elasticsearch security features are enabled, you must have the
manage_slm
or read_slm
cluster privileges to use this API.
For more information, see Security privileges.
Examplesedit
response = client.slm.get_status puts response
GET _slm/status
The API returns the following result:
{ "operation_mode": "RUNNING" }