mirror of
https://github.com/honeymoose/OpenSearch.git
synced 2025-02-07 21:48:39 +00:00
e012ac4649
Adds HLRC documentation for Start ILM, Stop ILM, and ILM Status APIs, as these APIs are tightly linked to each other.
37 lines
946 B
Plaintext
37 lines
946 B
Plaintext
--
|
|
:api: ilm-status
|
|
:request: LifecycleManagementStatusRequest
|
|
:response: AcknowledgedResponse
|
|
--
|
|
|
|
[id="{upid}-{api}"]
|
|
=== Index Lifecycle Management Status API
|
|
|
|
|
|
[id="{upid}-{api}-request"]
|
|
==== Request
|
|
|
|
The Index Lifecycle Management Status API allows you to retrieve the status
|
|
of Index Lifecycle Management
|
|
|
|
["source","java",subs="attributes,callouts,macros"]
|
|
--------------------------------------------------
|
|
include-tagged::{doc-tests-file}[{api}-request]
|
|
--------------------------------------------------
|
|
|
|
|
|
[id="{upid}-{api}-response"]
|
|
==== Response
|
|
|
|
The returned +{response}+ indicates the status of Index Lifecycle Management.
|
|
|
|
["source","java",subs="attributes,callouts,macros"]
|
|
--------------------------------------------------
|
|
include-tagged::{doc-tests-file}[{api}-response]
|
|
--------------------------------------------------
|
|
<1> The returned status can be `RUNNING`, `STOPPING`, or `STOPPED`.
|
|
|
|
include::../execution.asciidoc[]
|
|
|
|
|