61 lines
1.5 KiB
Plaintext
61 lines
1.5 KiB
Plaintext
[role="xpack"]
|
|
[testenv="basic"]
|
|
[[ilm-retry-policy]]
|
|
=== Retry policy execution API
|
|
++++
|
|
<titleabbrev>Retry policy</titleabbrev>
|
|
++++
|
|
|
|
Retry executing the policy for an index that is in the ERROR step.
|
|
|
|
[[ilm-retry-policy-request]]
|
|
==== {api-request-title}
|
|
|
|
`POST <index>/_ilm/retry`
|
|
|
|
[[ilm-retry-policy-prereqs]]
|
|
==== {api-prereq-title}
|
|
|
|
* If the {es} {security-features} are enabled, you must have the `manage_ilm`
|
|
privileges on the indices being managed to use this API. For more information,
|
|
see <<security-privileges>>.
|
|
|
|
[[ilm-retry-policy-desc]]
|
|
==== {api-description-title}
|
|
|
|
Sets the policy back to the step where the error occurred and executes the step.
|
|
Use the <<ilm-explain-lifecycle, ILM Explain API>> to determine if an index is in the ERROR
|
|
step.
|
|
|
|
[[ilm-retry-policy-path-params]]
|
|
==== {api-path-parms-title}
|
|
|
|
`<index>`::
|
|
(Required, string) Identifier for the indices to retry in comma-separated format.
|
|
|
|
[[ilm-retry-policy-query-params]]
|
|
==== {api-query-parms-title}
|
|
|
|
include::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
|
|
|
|
[[ilm-retry-policy-example]]
|
|
==== {api-examples-title}
|
|
|
|
The following example retries the policy for `my_index`.
|
|
|
|
[source,js]
|
|
--------------------------------------------------
|
|
POST my_index/_ilm/retry
|
|
--------------------------------------------------
|
|
// NOTCONSOLE
|
|
|
|
If the request succeeds, you receive the following result:
|
|
|
|
[source,js]
|
|
--------------------------------------------------
|
|
{
|
|
"acknowledged": true
|
|
}
|
|
--------------------------------------------------
|
|
// NOTCONSOLE
|