start.asciidoc 1.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384
  1. [role="xpack"]
  2. [testenv="basic"]
  3. [[ilm-start]]
  4. === Start {ILM} API
  5. ++++
  6. <titleabbrev>Start {ILM}</titleabbrev>
  7. ++++
  8. Start the {ILM} plugin.
  9. ==== Request
  10. `POST /_ilm/start`
  11. ==== Description
  12. Starts the {ILM} plugin if it is currently stopped. {ILM} is started
  13. automatically when the cluster is formed. Restarting {ILM} is only
  14. necessary if it has been stopped using the <<ilm-stop, Stop {ILM} API>>.
  15. ==== Request Parameters
  16. include::{docdir}/rest-api/timeoutparms.asciidoc[]
  17. ==== Authorization
  18. include::ilm-cluster-mgt-privilege.asciidoc[]
  19. ==== Examples
  20. The following example starts the ILM plugin.
  21. //////////////////////////
  22. [source,js]
  23. --------------------------------------------------
  24. PUT _ilm/policy/my_policy
  25. {
  26. "policy": {
  27. "phases": {
  28. "warm": {
  29. "min_age": "10d",
  30. "actions": {
  31. "forcemerge": {
  32. "max_num_segments": 1
  33. }
  34. }
  35. },
  36. "delete": {
  37. "min_age": "30d",
  38. "actions": {
  39. "delete": {}
  40. }
  41. }
  42. }
  43. }
  44. }
  45. PUT my_index
  46. POST _ilm/stop
  47. --------------------------------------------------
  48. // CONSOLE
  49. // TEST
  50. //////////////////////////
  51. [source,js]
  52. --------------------------------------------------
  53. POST _ilm/start
  54. --------------------------------------------------
  55. // CONSOLE
  56. // TEST[continued]
  57. If the request succeeds, you receive the following result:
  58. [source,js]
  59. --------------------------------------------------
  60. {
  61. "acknowledged": true
  62. }
  63. --------------------------------------------------
  64. // CONSOLE
  65. // TESTRESPONSE