elasticsearch/docs/reference
Lee Hinman 997db17852
Add usage to get ILM policy response (#74518)
This commit adds the "in_use_by" object to the response for ILM policies. This map shows the
indices, data streams, and composable templates that use the ILM policy.

An example output may look like:

```json
{
  "logs" : {
    "version" : 1,
    "modified_date" : "2021-06-23T18:42:08.381Z",
    "policy" : {
      ...
    },
    "in_use_by" : {
      "indices" : [".ds-logs-foo-barbaz-2021.06.23-000001", ".ds-logs-foo-other-2021.06.23-000001"],
      "data_streams" : ["logs-foo-barbaz", "logs-foo-other"],
      "composable_templates" : ["logs"]
    }
  }
}
```

Resolves #73869
2021-06-23 16:01:19 -06:00
..
aggregations Document types terms agg can consume (#73272) 2021-06-17 14:58:20 -04:00
analysis [DOCS] Fix formatting 2021-05-04 12:29:14 -04:00
autoscaling Autoscale frozen tier into existence (#73435) 2021-06-22 13:21:04 +02:00
cat [DOCS] Update <alias> parameter for cat aliases API (#73526) 2021-05-28 10:03:46 -04:00
ccr [DOCS] Update central reporting image (#74195) 2021-06-16 17:29:30 -04:00
cluster [DOCS] Update alias references (#73427) 2021-05-27 16:00:57 -04:00
commands Service Accounts - add beta version documentation (#71729) 2021-05-13 07:55:42 -04:00
data-management [DOCS] How to migrate to node roles from node attrs. Closes #65855 (#71160) 2021-04-27 14:39:54 -07:00
data-streams [DOCS] Update alias references (#73427) 2021-05-27 16:00:57 -04:00
docs [DOCS] Note remote reindex does not support slicing (#73959) 2021-06-22 09:00:37 -04:00
eql [DOCS] EQL: Note EQL uses fields parameter (#74194) 2021-06-16 13:01:02 -04:00
features/apis Make feature reset API response more informative (#71240) 2021-04-27 13:47:10 -04:00
fleet Wait on index when polling global checkpoints (#71890) 2021-04-20 13:04:42 -06:00
graph [DOCS] Fix API titles (#67475) 2021-01-13 15:15:37 -05:00
high-availability [DOCS] Replace 'log into' with 'log in to' (#72324) 2021-04-27 15:27:22 -04:00
how-to [DOCS] Remove unneeded on-page TOC 2021-06-17 08:40:56 -04:00
ilm Add usage to get ILM policy response (#74518) 2021-06-23 16:01:19 -06:00
images SQL: Add ODBC proxy support documentation (#73263) 2021-05-20 16:56:02 +02:00
index-modules [doc] Fix typo in slowlog.asciidoc (#73803) 2021-06-07 09:50:50 +02:00
indices [DOCS] Fix capitalization (#74470) 2021-06-23 12:02:57 -04:00
ingest Add template snippets support for KV ingest processor (#73758) 2021-06-22 16:32:11 -05:00
licensing [DOCS] Note get license API can return a 404 (#73951) 2021-06-10 09:19:20 -04:00
mapping [DOCS] add missing dynamic runtime option (#74294) 2021-06-21 09:13:21 -04:00
migration Breaking change for single data node setting (#73737) 2021-06-07 13:12:04 +02:00
ml [ML] add datafeed field to the job config (#74265) 2021-06-23 08:06:58 -04:00
modules [DOC] Add watcher to the threadpool doc (#73935) 2021-06-16 11:07:36 -04:00
monitoring Recommend cluster scope for Metricbeat (#70865) 2021-05-10 14:16:46 +01:00
query-dsl Add doc on rank_feature(s) negative score impact (#71795) 2021-04-20 06:56:05 -04:00
release-notes [DOCS] Replace version-specific links in release highlights (#70317) (#70386) 2021-03-15 10:20:12 -04:00
repositories-metering-api [DOCS] Fix name of cluster_version parameter (#69615) 2021-03-01 08:54:47 -05:00
rest-api [DOCS] Reuse aliases object properties in API docs (#73421) 2021-06-02 08:31:42 -04:00
rollup [DOCS] Fix double spaces (#71082) 2021-03-31 09:57:47 -04:00
scripting [DOCS] Add missing request section for delete stored script API (#74240) 2021-06-17 09:07:32 -04:00
search Add extra profiling information to terms agg (#73636) 2021-06-21 10:10:41 -04:00
searchable-snapshots [DOCS] Update alias references (#73427) 2021-05-27 16:00:57 -04:00
settings [DOCS] Fix client_authentication setting default (#73743) 2021-06-04 14:22:47 +10:00
setup [DOCS] Remove PrintCompressedOopsMode JVM option (#73741) 2021-06-09 09:43:33 -04:00
slm [DOCS] Clarify when SLM deletes expired snapshots (#73155) 2021-05-17 10:02:08 -04:00
snapshot-restore Pagination and Sorting for Get Snapshots API (#73952) 2021-06-17 09:00:11 +02:00
sql [DOCS] SQL: Document null handling for functions (#74444) 2021-06-23 11:11:26 -04:00
tab-widgets [DOCS] Rename mount types for searchable snapshots (#72699) 2021-05-05 16:35:33 -04:00
text-structure/apis [ML] [DOCS] update find-structure reference docs (#67586) 2021-01-15 12:19:38 -05:00
transform [DOCS] enhance transform example with range filter (#74284) 2021-06-21 10:37:11 +02:00
upgrade [DOCS] Note remote reindex does not support slicing (#73959) 2021-06-22 09:00:37 -04:00
vectors Add access to dense_vector values (#71313) 2021-04-19 08:02:05 -04:00
aggregations.asciidoc Convert bucket aggs docs to runtime fields (#71202) 2021-04-02 12:12:06 -04:00
alias.asciidoc [DOCS] Use bool query in alias filter example (#73619) 2021-06-01 12:05:40 -04:00
analysis.asciidoc [DOCS] Fix Lucene's stop words links (#70405) 2021-03-16 17:06:12 -04:00
api-conventions.asciidoc [DOCS] Update alias references (#73427) 2021-05-27 16:00:57 -04:00
cat.asciidoc [DOCS] Remove unneeded escapes 2021-04-26 12:14:45 -04:00
cluster.asciidoc [DOCS] Reword node roles docs (#69301) 2021-02-23 11:32:46 -05:00
data-management.asciidoc [DOCS] Move Kibana index mgmt docs to ES (#64380) 2020-10-30 09:14:52 -04:00
data-rollup-transform.asciidoc [DOCS] Add overview for rollup refactor (#70001) 2021-03-10 08:41:27 -05:00
datatiers.asciidoc [DOCS] recommend dedicated frozen tier (#72882) 2021-05-11 20:41:10 +02:00
dependencies-versions.asciidoc [DOCS] Added appendix to show dependencies (#67962) 2021-01-26 16:16:05 -08:00
docs.asciidoc [DOCS] Update single index APIs reference (#73103) 2021-05-14 11:53:34 -04:00
getting-started.asciidoc [DOCS] Minor edits for better readability 2021-06-17 08:49:16 -04:00
glossary.asciidoc [DOCS] Add multi-field def to glossary (#74147) 2021-06-15 16:39:46 -04:00
gs-index.asciidoc [DOCS] Adding index file for GS "mini book". 2017-07-18 13:44:08 -07:00
high-availability.asciidoc [DOCS] Add docs for designing resilient clusters (#47233) 2020-06-05 11:48:44 -04:00
how-to.asciidoc [DOCS] Add 'Fix common cluster issues' docs (#72097) 2021-04-28 08:28:51 -04:00
index-extra-title-page.html [DOCS] Add index-extra-title-page.html for direct HTML migration (#50189) 2019-12-13 12:44:12 -05:00
index-modules.asciidoc Improve check_on_startup docs and logging (#74233) 2021-06-18 07:46:51 +01:00
index.asciidoc Fix docs path for docs PR to pass 2021-06-01 16:55:13 +02:00
index.x.asciidoc [DOCS] Removes redundant index.asciidoc files (#30707) 2018-05-18 11:05:40 -07:00
indices.asciidoc [DOCS] Add alias guide (#73062) 2021-05-25 11:52:16 -04:00
ingest.asciidoc Expose dynamic_templates parameter in Ingest (#71716) 2021-04-19 11:34:13 -04:00
intro.asciidoc [DOCS] Fix double spaces (#71082) 2021-03-31 09:57:47 -04:00
links.asciidoc [DOCS] Rename ES Reference to ES Guide (#71198) 2021-04-01 15:38:41 -04:00
mapping.asciidoc Minor revision missed in merge. (#67282) 2021-01-11 13:50:06 -05:00
query-dsl.asciidoc [DOC] Fix typos (#71869) (#71948) 2021-04-20 11:47:29 -04:00
redirects.asciidoc [DOCS] Create a new page for grok content in scripting docs (#73118) 2021-05-27 15:18:34 -04:00
release-notes.asciidoc [DOCS] Adds placeholders for v8 highlights, breaking changes, release notes (#38641) 2019-02-08 15:48:42 -08:00
scripting.asciidoc [DOCS] Move common scripting use cases up a level (#73445) 2021-05-27 07:38:55 -04:00
search.asciidoc Links new TermsEnum api into docs. Remove superfluous “API” from page title. (#72992) 2021-05-12 16:21:36 +01:00
setup.asciidoc [DOCS] Edit JVM settings info. Closes #72259 (#72350) 2021-04-28 18:30:32 -07:00
upgrade.asciidoc [DOCS] Add tip for upgrade assistant (#55027) 2020-05-05 09:49:22 -04:00