retry-policy.asciidoc 1.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354
  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. include::ilm-index-mgt-privilege.asciidoc[]
  23. ==== Examples
  24. The following example retries the policy for `my_index`.
  25. [source,js]
  26. --------------------------------------------------
  27. POST my_index/_ilm/retry
  28. --------------------------------------------------
  29. // NOTCONSOLE
  30. If the request succeeds, you receive the following result:
  31. [source,js]
  32. --------------------------------------------------
  33. {
  34. "acknowledged": true
  35. }
  36. --------------------------------------------------
  37. // NOTCONSOLE