mirror of
https://github.com/honeymoose/OpenSearch.git
synced 2025-02-08 22:14:59 +00:00
c0156cbb5d
* [DOCS] Align with ILM API docs (#48705) * [DOCS] Reconciled with Snapshot/Restore reorg * [DOCS] Split off ILM overview to a separate topic. (#51287) * [DOCS} Split off overview to a separate topic. * [DOCS] Incorporated feedback from @jrodewig. * [DOCS] Edit ILM GS tutorial (#51513) * [DOCS] Edit ILM GS tutorial * [DOCS] Incorporated review feedback from @andreidan. * [DOCS] Removed test link & fixed anchor & title. * Update docs/reference/ilm/getting-started-ilm.asciidoc Co-Authored-By: James Rodewig <james.rodewig@elastic.co> * Fixed glossary merge error. Co-authored-by: James Rodewig <james.rodewig@elastic.co>
44 lines
1.3 KiB
Plaintext
44 lines
1.3 KiB
Plaintext
[role="xpack"]
|
|
[testenv="basic"]
|
|
[[snapshot-lifecycle-management-api]]
|
|
== {slm-cap} API
|
|
|
|
You use the following APIs to set up policies to automatically take snapshots and
|
|
control how long they are retained.
|
|
For more information about {slm} ({slm-init}), see <<snapshot-lifecycle-management>>.
|
|
|
|
[float]
|
|
[[slm-api-policy-endpoint]]
|
|
=== Policy management APIs
|
|
|
|
* <<slm-api-put-policy,Create lifecycle policy>>
|
|
* <<slm-api-get-policy,Get lifecycle policy>>
|
|
* <<slm-api-delete-policy,Delete lifecycle policy>>
|
|
|
|
[float]
|
|
[[slm-api-index-endpoint]]
|
|
=== Snapshot management APIs
|
|
|
|
* <<slm-api-execute-lifecycle,Execute snapshot lifecycle policy>> (take snapshots)
|
|
* <<slm-api-execute-retention,Execute snapshot retention policy>> (delete expired snapshots)
|
|
|
|
[float]
|
|
[[slm-api-management-endpoint]]
|
|
=== Operation management APIs
|
|
|
|
* <<slm-api-get-status,Get {slm-init} status>>
|
|
* <<slm-api-get-stats,Get global and policy-level action statistics>>
|
|
* <<slm-api-start,Start {slm-init}>>
|
|
* <<slm-api-stop,Stop {slm-init}>>
|
|
|
|
include::slm-put.asciidoc[]
|
|
include::slm-get.asciidoc[]
|
|
include::slm-delete.asciidoc[]
|
|
|
|
include::slm-execute.asciidoc[]
|
|
include::slm-execute-retention.asciidoc[]
|
|
|
|
include::slm-get-status.asciidoc[]
|
|
include::slm-stats.asciidoc[]
|
|
include::slm-start.asciidoc[]
|
|
include::slm-stop.asciidoc[] |