54 lines
1.3 KiB
Plaintext
54 lines
1.3 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.
|
|
|
|
==== Request
|
|
|
|
`POST <index>/_ilm/retry`
|
|
|
|
==== Description
|
|
|
|
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.
|
|
|
|
==== Path Parameters
|
|
|
|
`index` (required)::
|
|
(string) Identifier for the indices to retry in comma-separated format.
|
|
|
|
==== Request Parameters
|
|
|
|
include::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
|
|
|
|
==== Authorization
|
|
|
|
You must have the `manage_ilm` privileges on the indices being managed to use this API.
|
|
For more information, see {stack-ov}/security-privileges.html[Security Privileges].
|
|
|
|
==== Examples
|
|
|
|
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
|