lifecycle_management_status.asciidoc 960 B

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