|
| 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/] |
0 commit comments