mirror of
https://github.com/honeymoose/OpenSearch.git
synced 2025-02-13 00:15:47 +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>
45 lines
1.1 KiB
Plaintext
45 lines
1.1 KiB
Plaintext
[[index-lifecycle-management-api]]
|
|
== {ilm-cap} API
|
|
|
|
You use the following APIs to set up policies to automatically manage the index lifecycle.
|
|
For more information about {ilm} ({ilm-init}), see <<index-lifecycle-management>>.
|
|
|
|
[float]
|
|
[[ilm-api-policy-endpoint]]
|
|
=== Policy management APIs
|
|
|
|
* <<ilm-put-lifecycle,Create lifecycle policy>>
|
|
* <<ilm-get-lifecycle,Get lifecycle policy>>
|
|
* <<ilm-delete-lifecycle,Delete lifecycle policy>>
|
|
|
|
[float]
|
|
[[ilm-api-index-endpoint]]
|
|
=== Index management APIs
|
|
|
|
* <<ilm-move-to-step,Move index to step>>
|
|
* <<ilm-retry-policy,Retry policy on indices>>
|
|
* <<ilm-remove-policy,Remove policy from index>>
|
|
|
|
[float]
|
|
[[ilm-api-management-endpoint]]
|
|
=== Operation management APIs
|
|
|
|
* <<ilm-get-status,Get ILM operation mode>>
|
|
* <<ilm-start,Start ILM>>
|
|
* <<ilm-stop,Stop ILM>>
|
|
* <<ilm-explain-lifecycle,Explain API>>
|
|
|
|
|
|
include::put-lifecycle.asciidoc[]
|
|
include::get-lifecycle.asciidoc[]
|
|
include::delete-lifecycle.asciidoc[]
|
|
|
|
include::move-to-step.asciidoc[]
|
|
include::remove-policy-from-index.asciidoc[]
|
|
include::retry-policy.asciidoc[]
|
|
|
|
include::get-status.asciidoc[]
|
|
include::explain.asciidoc[]
|
|
include::start.asciidoc[]
|
|
include::stop.asciidoc[]
|