mirror of
https://github.com/honeymoose/OpenSearch.git
synced 2025-02-10 06:55:32 +00:00
8a662c7e62
* [DOCS] Rework conceptual info for ILM. (#52181) * [DOCS] Rework conceptual info for ILM. * Split the actions out of concepts. * Added xpack role to actions. Co-Authored-By: James Rodewig <james.rodewig@elastic.co> * Apply suggestions from code review * Edit actions for consistency and add action template. (#55632) * Edit actions for consistency and add action template. * Update docs/reference/ilm/actions/ilm-readonly.asciidoc Co-Authored-By: James Rodewig <james.rodewig@elastic.co> * Apply suggestions from code review
56 lines
1.4 KiB
Plaintext
56 lines
1.4 KiB
Plaintext
[role="xpack"]
|
|
[testenv="basic"]
|
|
[[ilm-get-status]]
|
|
=== Get {ilm} status API
|
|
|
|
[subs="attributes"]
|
|
++++
|
|
<titleabbrev>Get {ilm} status</titleabbrev>
|
|
++++
|
|
|
|
Retrieves the current {ilm} ({ilm-init}) status.
|
|
|
|
[[ilm-get-status-request]]
|
|
==== {api-request-title}
|
|
|
|
`GET /_ilm/status`
|
|
|
|
[[ilm-get-status-prereqs]]
|
|
==== {api-prereq-title}
|
|
|
|
* If the {es} {security-features} are enabled, you must have the `manage_ilm` or
|
|
`read_ilm` or both cluster privileges to use this API. For more information, see
|
|
<<security-privileges>>.
|
|
|
|
[[ilm-get-status-desc]]
|
|
==== {api-description-title}
|
|
|
|
Returns the status of the {ilm-init} 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-init} plugin with the
|
|
<<ilm-start,start {ilm-init}>> and <<ilm-stop,stop {ilm-init}>> APIs.
|
|
|
|
[[ilm-get-status-query-params]]
|
|
==== {api-query-parms-title}
|
|
|
|
include::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
|
|
|
|
[[ilm-get-status-example]]
|
|
==== {api-examples-title}
|
|
|
|
The following example gets the {ilm-init} plugin status.
|
|
|
|
[source,console]
|
|
--------------------------------------------------
|
|
GET _ilm/status
|
|
--------------------------------------------------
|
|
|
|
If the request succeeds, the body of the response shows the operation mode:
|
|
|
|
[source,console-result]
|
|
--------------------------------------------------
|
|
{
|
|
"operation_mode": "RUNNING"
|
|
}
|
|
--------------------------------------------------
|