mirror of
https://github.com/honeymoose/OpenSearch.git
synced 2025-02-06 13:08:29 +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.
37 lines
980 B
Plaintext
37 lines
980 B
Plaintext
--
|
|
:api: slm-status
|
|
:request: SnapshotLifecycleManagementStatusRequest
|
|
:response: AcknowledgedResponse
|
|
--
|
|
[role="xpack"]
|
|
[id="{upid}-{api}"]
|
|
=== Snapshot Lifecycle Management Status API
|
|
|
|
|
|
[id="{upid}-{api}-request"]
|
|
==== Request
|
|
|
|
The Snapshot Lifecycle Management Status API allows you to retrieve the status
|
|
of Snapshot 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 Snapshot 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[]
|
|
|
|
|