mirror of
https://github.com/honeymoose/OpenSearch.git
synced 2025-02-07 21:48:39 +00:00
8a662c7e62
* [DOCS] Rework conceptual info for ILM. (#52181) * [DOCS] Rework conceptual info for ILM. * Split the actions out of concepts. * Added xpack role to actions. Co-Authored-By: James Rodewig <james.rodewig@elastic.co> * Apply suggestions from code review * Edit actions for consistency and add action template. (#55632) * Edit actions for consistency and add action template. * Update docs/reference/ilm/actions/ilm-readonly.asciidoc Co-Authored-By: James Rodewig <james.rodewig@elastic.co> * Apply suggestions from code review
45 lines
1.2 KiB
Plaintext
45 lines
1.2 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>>.
|
|
|
|
[discrete]
|
|
[[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>>
|
|
|
|
[discrete]
|
|
[[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>>
|
|
|
|
[discrete]
|
|
[[ilm-api-management-endpoint]]
|
|
=== Operation management APIs
|
|
|
|
* <<ilm-get-status,Get {ilm-init} operation mode>>
|
|
* <<ilm-start,Start {ilm-init}>>
|
|
* <<ilm-stop,Stop {ilm-init}>>
|
|
* <<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[]
|