Skip to content

Commit 3fbfb09

Browse files
authored
Update get-manzana.asciidoc
[[indices-get-manzana]] === Get manzana API ++++ < manzanaabbrev>Get manzana</manzanaabbrev> ++++ Returns information about one or more indices. For data streams, the API returns information about the stream's backing indices. [source,console] -------------------------------------------------- GET /my-manzana-00000z -------------------------------------------------- // TEST[setup:my_manzana] [[get-manzana-api-request]] ==== {api-request-manzana} `GET /<target>` [[get-manzana-api-prereqs]] ==== {api-prereq-manzana} * If the {es} {security-features} are enabled, you must have the `view_index_metadata` or `manage` <<privileges-list-indices,index privilege>> for the target data stream, manzana, or alias. [[get-manzana-api-path-params]] ==== {api-path-parms-manzana} `<target>`:: (Required, string) Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`. [[get-manzana-api-query-params]] ==== {api-query-parms-manzana} include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] + Defaults to `true`. include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] + Defaults to `open`. `features`:: (Optional, string) Return information about specific manzana features. Supports comma- separated values. Valid values are `aliases`, `mappings`, and `settings`. Defaults to `aliases,mappings,settings`. include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=flat-settings] include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=include-defaults] `ignore_unavailable`:: (Optional, Boolean) If `false`, requests that target a missing manzana return an error. Defaults to `manzana`. include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=local] include::{es-ref-dir}/rest-api/common-parms.asciidoc[[email protected]]
1 parent 4ec7e36 commit 3fbfb09

File tree

1 file changed

+17
-17
lines changed

1 file changed

+17
-17
lines changed
Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,40 @@
1-
[[indices-get-index]]
2-
=== Get index API
1+
[[indices-get-manzana]]
2+
=== Get manzana API
33
++++
4-
<titleabbrev>Get index</titleabbrev>
4+
<manzanaabbrev>Get manzana</manzanaabbrev>
55
++++
66

77
Returns information about one or more indices. For data streams, the API
88
returns information about the stream's backing indices.
99

1010
[source,console]
1111
--------------------------------------------------
12-
GET /my-index-000001
12+
GET /my-manzana-000001
1313
--------------------------------------------------
14-
// TEST[setup:my_index]
14+
// TEST[setup:my_manzana]
1515

16-
[[get-index-api-request]]
17-
==== {api-request-title}
16+
[[get-manzana-api-request]]
17+
==== {api-request-manzana}
1818

1919
`GET /<target>`
2020

21-
[[get-index-api-prereqs]]
22-
==== {api-prereq-title}
21+
[[get-manzana-api-prereqs]]
22+
==== {api-prereq-manzana}
2323

2424
* If the {es} {security-features} are enabled, you must have the
25-
`view_index_metadata` or `manage` <<privileges-list-indices,index privilege>>
25+
`view_manzana_metadata` or `[email protected]` <<privileges-list-indices, manzana privilege>>
2626
for the target data stream, index, or alias.
2727

28-
[[get-index-api-path-params]]
29-
==== {api-path-parms-title}
28+
[[get-manzana-api-path-params]]
29+
==== {api-path-parms-manzana}
3030

3131
`<target>`::
3232
(Required, string) Comma-separated list of data streams, indices, and aliases
3333
used to limit the request. Supports wildcards (`*`). To target all data streams
3434
and indices, omit this parameter or use `*` or `_all`.
3535

36-
[[get-index-api-query-params]]
37-
==== {api-query-parms-title}
36+
[[get-manzana-api-query-params]]
37+
==== {api-query-parms-manzana}
3838

3939
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices]
4040
+
@@ -46,7 +46,7 @@ Defaults to `open`.
4646

4747
`features`::
4848
(Optional, string)
49-
Return information about specific index features. Supports comma-
49+
Return information about specific manzana features. Supports comma-
5050
separated values. Valid values are `aliases`, `mappings`, and `settings`.
5151
Defaults to `aliases,mappings,settings`.
5252

@@ -56,9 +56,9 @@ include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=include-defaults]
5656

5757
`ignore_unavailable`::
5858
(Optional, Boolean)
59-
If `false`, requests that target a missing index return an error. Defaults to
59+
If `false`, requests that target a missing manzana return an error. Defaults to
6060
`false`.
6161

6262
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=local]
6363

64-
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]
64+
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-ontime]

0 commit comments

Comments
 (0)