Skip to content

Commit 01449bb

Browse files
committed
[DOCS] Add index alias exists API docs (#46042)
1 parent 5cecad8 commit 01449bb

File tree

3 files changed

+82
-13
lines changed

3 files changed

+82
-13
lines changed

docs/reference/indices.asciidoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ index settings, aliases, mappings, and index templates.
3333
[float]
3434
[[alias-management]]
3535
=== Alias management:
36+
* <<indices-alias-exists>>
3637
* <<indices-aliases>>
3738

3839
[float]
@@ -89,6 +90,8 @@ include::indices/get-field-mapping.asciidoc[]
8990

9091
include::indices/types-exists.asciidoc[]
9192

93+
include::indices/alias-exists.asciidoc[]
94+
9295
include::indices/aliases.asciidoc[]
9396

9497
include::indices/update-settings.asciidoc[]
Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
[[indices-alias-exists]]
2+
=== Index alias exists API
3+
++++
4+
<titleabbrev>Index alias exists</titleabbrev>
5+
++++
6+
7+
Checks if an index alias exists.
8+
9+
//tag::index-alias-def[]
10+
An index alias is a secondary name
11+
used to refer to one or more existing indices.
12+
//end::index-alias-def[]
13+
14+
The returned HTTP status code indicates whether the index alias exists or not.
15+
A `404` means it does not exist,
16+
and `200` means it does.
17+
18+
[source,js]
19+
----
20+
HEAD /_alias/alias1
21+
----
22+
// CONSOLE
23+
// TEST[setup:twitter]
24+
// TEST[s/^/PUT twitter\/_alias\/alias1\n/]
25+
26+
27+
[[alias-exists-api-request]]
28+
==== {api-request-title}
29+
30+
`HEAD /_alias/<alias>`
31+
32+
`HEAD /<index>/_alias/<alias>`
33+
34+
35+
[[alias-exists-api-path-params]]
36+
==== {api-path-parms-title}
37+
38+
`<alias>`::
39+
(Required, string)
40+
Comma-separated list or wildcard expression of index alias names
41+
used to limit the request.
42+
43+
include::{docdir}/rest-api/common-parms.asciidoc[tag=index]
44+
45+
[[alias-exists-api-query-params]]
46+
==== {api-query-parms-title}
47+
48+
include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices]
49+
50+
include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards]
51+
+
52+
Defaults to `all`.
53+
54+
include::{docdir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable]
55+
56+
include::{docdir}/rest-api/common-parms.asciidoc[tag=local]
57+
58+
59+
[[alias-exists-api-response-codes]]
60+
==== {api-response-codes-title}
61+
62+
`200`::
63+
Indicates all specified index aliases exist.
64+
65+
`404`::
66+
Indicates one or more specified index aliases **do not** exist.
67+
68+
69+
[[alias-exists-api-example]]
70+
==== {api-examples-title}
71+
72+
[source,js]
73+
----
74+
HEAD /_alias/2030
75+
HEAD /_alias/20*
76+
HEAD /logs_20302801/_alias/*
77+
----
78+
// CONSOLE
79+
// TEST[s/^/PUT logs_20302801\nPUT logs_20302801\/_alias\/2030\n/]

docs/reference/indices/aliases.asciidoc

Lines changed: 0 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -575,16 +575,3 @@ Response:
575575
}
576576
--------------------------------------------------
577577
// TESTRESPONSE
578-
579-
There is also a HEAD variant of the get indices aliases api to check if
580-
index aliases exist. The indices aliases exists api supports the same
581-
option as the get indices aliases api. Examples:
582-
583-
[source,js]
584-
--------------------------------------------------
585-
HEAD /_alias/2016
586-
HEAD /_alias/20*
587-
HEAD /logs_20162801/_alias/*
588-
--------------------------------------------------
589-
// CONSOLE
590-
// TEST[continued]

0 commit comments

Comments
 (0)