start_lifecycle_management.asciidoc 980 B

123456789101112131415161718192021222324252627282930313233343536
  1. --
  2. :api: ilm-start-ilm
  3. :request: StartILMRequest
  4. :response: AcknowledgedResponse
  5. --
  6. [id="{upid}-{api}"]
  7. === Start Index Lifecycle Management API
  8. [id="{upid}-{api}-request"]
  9. ==== Request
  10. The Start Lifecycle Management API allows you to start Index Lifecycle
  11. Management if it has previously been stopped.
  12. ["source","java",subs="attributes,callouts,macros"]
  13. --------------------------------------------------
  14. include-tagged::{doc-tests-file}[{api}-request]
  15. --------------------------------------------------
  16. [id="{upid}-{api}-response"]
  17. ==== Response
  18. The returned +{response}+ indicates if the request to start Index Lifecycle
  19. Management was received.
  20. ["source","java",subs="attributes,callouts,macros"]
  21. --------------------------------------------------
  22. include-tagged::{doc-tests-file}[{api}-response]
  23. --------------------------------------------------
  24. <1> Whether or not the request to start Index Lifecycle Management was
  25. acknowledged.
  26. include::../execution.asciidoc[]