retry-policy.asciidoc 1.1 KB

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