honeymoose/OpenSearch
1
0
Fork 0
mirror of https://github.com/honeymoose/OpenSearch.git synced 2025-02-23 05:15:04 +00:00
Code Issues Packages Projects Releases Wiki Activity

[DOCS] Add data streams to ILM explain API (#59343) (#59411)

Browse Source
This commit is contained in:
James Rodewig 2020-07-13 09:04:42 -04:00 committed by GitHub
parent 896d0ffd9b
commit 35a78b88ab
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
docs/reference/ilm/apis/explain.asciidoc
View File

@ -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}
@ -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}