mirror of
https://github.com/honeymoose/OpenSearch.git
synced 2025-02-15 01:16:09 +00:00
e012ac4649
Adds HLRC documentation for Start ILM, Stop ILM, and ILM Status APIs, as these APIs are tightly linked to each other.
39 lines
953 B
Plaintext
39 lines
953 B
Plaintext
--
|
|
:api: ilm-stop-ilm
|
|
:request: StopILMRequest
|
|
:response: AcknowledgedResponse
|
|
--
|
|
|
|
[id="{upid}-{api}"]
|
|
=== Stop Index Lifecycle Management API
|
|
|
|
|
|
[id="{upid}-{api}-request"]
|
|
==== Request
|
|
|
|
The Stop Lifecycle Management API allows you to stop Index Lifecycle
|
|
Management temporarily.
|
|
|
|
["source","java",subs="attributes,callouts,macros"]
|
|
--------------------------------------------------
|
|
include-tagged::{doc-tests-file}[{api}-request]
|
|
--------------------------------------------------
|
|
|
|
|
|
[id="{upid}-{api}-response"]
|
|
==== Response
|
|
|
|
The returned +{response}+ indicates if the request to stop Index Lifecycle
|
|
Management was received.
|
|
|
|
["source","java",subs="attributes,callouts,macros"]
|
|
--------------------------------------------------
|
|
include-tagged::{doc-tests-file}[{api}-response]
|
|
--------------------------------------------------
|
|
<1> Whether or not the request to stop Index Lifecycle Management was
|
|
acknowledged.
|
|
|
|
include::../execution.asciidoc[]
|
|
|
|
|