OpenSearch/docs/reference/ilm/apis/retry-policy.asciidoc

61 lines
1.5 KiB
Plaintext
Raw Normal View History

[role="xpack"]
[testenv="basic"]
[[ilm-retry-policy]]
2018-12-20 13:23:28 -05:00
=== Retry policy execution API
++++
2018-12-20 13:23:28 -05:00
<titleabbrev>Retry policy</titleabbrev>
++++
Retry executing the policy for an index that is in the ERROR step.
2019-11-20 11:19:33 -05:00
[[ilm-retry-policy-request]]
==== {api-request-title}
`POST <index>/_ilm/retry`
2019-11-20 11:19:33 -05:00
[[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-init} Explain API>> to determine if an index is in the ERROR
step.
2019-11-20 11:19:33 -05:00
[[ilm-retry-policy-path-params]]
==== {api-path-parms-title}
2019-11-20 11:19:33 -05:00
`<index>`::
(Required, string) Identifier for the indices to retry in comma-separated format.
2019-11-20 11:19:33 -05:00
[[ilm-retry-policy-query-params]]
==== {api-query-parms-title}
include::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
2019-11-20 11:19:33 -05:00
[[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