Skip to content

Commit

Permalink
[DOCS] Add data streams to ILM explain API (#59343)
Browse files Browse the repository at this point in the history
  • Loading branch information
jrodewig authored Jul 13, 2020
1 parent cd75614 commit 55b6c1a
Showing 1 changed file with 10 additions and 4 deletions.
14 changes: 10 additions & 4 deletions docs/reference/ilm/apis/explain.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,14 @@
<titleabbrev>Explain lifecycle</titleabbrev>
++++

Shows an index's current lifecycle status.
Retrieves the current lifecycle status for one or more indices. For data
streams, the API retrieves the current lifecycle status for the stream's backing
indices.

[[ilm-explain-lifecycle-request]]
==== {api-request-title}

`GET <index>/_ilm/explain`
`GET <target>/_ilm/explain`

[[ilm-explain-lifecycle-prereqs]]
==== {api-prereq-title}
Expand All @@ -31,8 +33,12 @@ about any failures.
[[ilm-explain-lifecycle-path-params]]
==== {api-path-parms-title}

`<index>`::
(Required, string) Identifier for the index.
`<target>`::
(Required, string)
Comma-separated list of data streams, indices, and index aliases to target.
Wildcard expressions (`*`) are supported.
+
To target all data streams and indices in a cluster, use `_all` or `*`.

[[ilm-explain-lifecycle-query-params]]
==== {api-query-parms-title}
Expand Down

0 comments on commit 55b6c1a

Please sign in to comment.