[DOCS] Reformat get settings API docs (#45924)

This commit is contained in:
James Rodewig 2019-08-26 08:57:00 -04:00
parent db1ac81d63
commit 1b90019599
1 changed files with 53 additions and 11 deletions

View File

@ -1,7 +1,10 @@
[[indices-get-settings]] [[indices-get-settings]]
=== Get Settings === Get index settings API
++++
<titleabbrev>Get index settings</titleabbrev>
++++
The get settings API allows to retrieve settings of index/indices: Returns setting information for an index.
[source,js] [source,js]
-------------------------------------------------- --------------------------------------------------
@ -10,14 +13,54 @@ GET /twitter/_settings
// CONSOLE // CONSOLE
// TEST[setup:twitter] // TEST[setup:twitter]
[float]
==== Multiple Indices and Types
The get settings API can be used to get settings for more than one index [[get-index-settings-api-request]]
with a single call. General usage of the API follows the ==== {api-request-title}
following syntax: `host:port/{index}/_settings` where
`{index}` can stand for comma-separated list of index names and aliases. To `GET /<index>/_settings`
get settings for all indices you can use `_all` for `{index}`.
`GET /<index>/_settings/<setting>`
[[get-index-settings-api-path-params]]
==== {api-path-parms-title}
include::{docdir}/rest-api/common-parms.asciidoc[tag=index]
+
Use a value of `_all` to retrieve information for all indices in the cluster.
`<setting>`::
(Optional, string) Comma-separated list or wildcard expression of setting names
used to limit the request.
[[get-index-settings-api-query-params]]
==== {api-query-parms-title}
include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices]
include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards]
+
Defaults to `all`.
include::{docdir}/rest-api/common-parms.asciidoc[tag=flat-settings]
include::{docdir}/rest-api/common-parms.asciidoc[tag=include-defaults]
include::{docdir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable]
include::{docdir}/rest-api/common-parms.asciidoc[tag=local]
include::{docdir}/rest-api/common-parms.asciidoc[tag=master-timeout]
[[get-index-settings-api-example]]
==== {api-examples-title}
===== Multiple indices
The get settings API can be used to get settings for more than one index with a
single call. To get settings for all indices you can use `_all` for `<index>`.
Wildcard expressions are also supported. The following are some examples: Wildcard expressions are also supported. The following are some examples:
[source,js] [source,js]
@ -32,8 +75,7 @@ GET /log_2013_*/_settings
// TEST[setup:twitter] // TEST[setup:twitter]
// TEST[s/^/PUT kimchy\nPUT log_2013_01_01\n/] // TEST[s/^/PUT kimchy\nPUT log_2013_01_01\n/]
[float] ===== Filtering settings by name
==== Filtering settings by name
The settings that are returned can be filtered with wildcard matching The settings that are returned can be filtered with wildcard matching
as follows: as follows: