mirror of
https://github.com/honeymoose/OpenSearch.git
synced 2025-02-07 21:48:39 +00:00
300ddfa3c1
This commit adds HLRC support and documentation for the SLM Start and Stop APIs, as well as updating existing documentation where appropriate. This commit also ensures that the SLM APIs are properly included in the HLRC documentation.
39 lines
978 B
Plaintext
39 lines
978 B
Plaintext
--
|
|
:api: slm-stop-slm
|
|
:request: StopSLMRequest
|
|
:response: AcknowledgedResponse
|
|
--
|
|
[role="xpack"]
|
|
[id="{upid}-{api}"]
|
|
=== Stop Snapshot Lifecycle Management API
|
|
|
|
|
|
[id="{upid}-{api}-request"]
|
|
==== Request
|
|
|
|
The Stop Snapshot Management API allows you to stop Snapshot 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 Snapshot
|
|
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 Snapshot Lifecycle Management was
|
|
acknowledged.
|
|
|
|
include::../execution.asciidoc[]
|
|
|
|
|