retry-policy.asciidoc 1.5 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859
  1. [role="xpack"]
  2. [[ilm-retry-policy]]
  3. === Retry policy execution API
  4. ++++
  5. <titleabbrev>Retry policy</titleabbrev>
  6. ++++
  7. Retry executing the policy for an index that is in the ERROR step.
  8. [[ilm-retry-policy-request]]
  9. ==== {api-request-title}
  10. `POST <index>/_ilm/retry`
  11. [[ilm-retry-policy-prereqs]]
  12. ==== {api-prereq-title}
  13. * If the {es} {security-features} are enabled, you must have the `manage_ilm`
  14. privileges on the indices being managed to use this API. For more information,
  15. see <<security-privileges>>.
  16. [[ilm-retry-policy-desc]]
  17. ==== {api-description-title}
  18. Sets the policy back to the step where the error occurred and executes the step.
  19. Use the <<ilm-explain-lifecycle, {ilm-init} Explain API>> to determine if an index is in the ERROR
  20. step.
  21. [[ilm-retry-policy-path-params]]
  22. ==== {api-path-parms-title}
  23. `<index>`::
  24. (Required, string) Identifier for the indices to retry in comma-separated format.
  25. [[ilm-retry-policy-query-params]]
  26. ==== {api-query-parms-title}
  27. include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
  28. [[ilm-retry-policy-example]]
  29. ==== {api-examples-title}
  30. The following example retries the policy for `my-index-000001`.
  31. [source,js]
  32. --------------------------------------------------
  33. POST my-index-000001/_ilm/retry
  34. --------------------------------------------------
  35. // NOTCONSOLE
  36. If the request succeeds, you receive the following result:
  37. [source,js]
  38. --------------------------------------------------
  39. {
  40. "acknowledged": true
  41. }
  42. --------------------------------------------------
  43. // NOTCONSOLE