lifecycle_management_status.asciidoc 946 B

123456789101112131415161718192021222324252627282930313233343536
  1. --
  2. :api: ilm-status
  3. :request: LifecycleManagementStatusRequest
  4. :response: AcknowledgedResponse
  5. --
  6. [id="{upid}-{api}"]
  7. === Index Lifecycle Management Status API
  8. [id="{upid}-{api}-request"]
  9. ==== Request
  10. The Index Lifecycle Management Status API allows you to retrieve the status
  11. of Index Lifecycle Management
  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 the status of Index Lifecycle Management.
  19. ["source","java",subs="attributes,callouts,macros"]
  20. --------------------------------------------------
  21. include-tagged::{doc-tests-file}[{api}-response]
  22. --------------------------------------------------
  23. <1> The returned status can be `RUNNING`, `STOPPING`, or `STOPPED`.
  24. include::../execution.asciidoc[]