retry-policy.asciidoc 1.3 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455
  1. [role="xpack"]
  2. [testenv="basic"]
  3. [[ilm-retry-policy]]
  4. === Retry Policy Execution API
  5. ++++
  6. <titleabbrev>Retry Policy</titleabbrev>
  7. ++++
  8. beta[]
  9. Retry executing the policy for an index that is in the ERROR step.
  10. ==== Request
  11. `POST <index>/_ilm/retry`
  12. ==== Description
  13. Sets the policy back to the step where the error occurred and executes the step.
  14. Use the <<ilm-explain-lifecycle, ILM Explain API>> to determine if an index is in the ERROR
  15. step.
  16. ==== Path Parameters
  17. `index` (required)::
  18. (string) Identifier for the indices to retry in comma-separated format.
  19. ==== Request Parameters
  20. include::{docdir}/rest-api/timeoutparms.asciidoc[]
  21. ==== Authorization
  22. You must have the `manage_ilm` privileges on the indices being managed to use this API.
  23. For more information, see {stack-ov}/security-privileges.html[Security Privileges].
  24. ==== Examples
  25. The following example retries the policy for `my_index`.
  26. [source,js]
  27. --------------------------------------------------
  28. POST my_index/_ilm/retry
  29. --------------------------------------------------
  30. // NOTCONSOLE
  31. If the request succeeds, you receive the following result:
  32. [source,js]
  33. --------------------------------------------------
  34. {
  35. "acknowledged": true
  36. }
  37. --------------------------------------------------
  38. // NOTCONSOLE