alias-exists.asciidoc 1.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778
  1. [[indices-alias-exists]]
  2. === Index alias exists API
  3. ++++
  4. <titleabbrev>Index alias exists</titleabbrev>
  5. ++++
  6. Checks if an index alias exists.
  7. //tag::index-alias-def[]
  8. An index alias is a secondary name
  9. used to refer to one or more existing indices.
  10. //end::index-alias-def[]
  11. The returned HTTP status code indicates whether the index alias exists or not.
  12. A `404` means it does not exist,
  13. and `200` means it does.
  14. [source,js]
  15. ----
  16. HEAD /_alias/alias1
  17. ----
  18. // CONSOLE
  19. // TEST[setup:twitter]
  20. // TEST[s/^/PUT twitter\/_alias\/alias1\n/]
  21. [[alias-exists-api-request]]
  22. ==== {api-request-title}
  23. `HEAD /_alias/<alias>`
  24. `HEAD /<index>/_alias/<alias>`
  25. [[alias-exists-api-path-params]]
  26. ==== {api-path-parms-title}
  27. `<alias>`::
  28. (Required, string)
  29. include::{docdir}/rest-api/common-parms.asciidoc[tag=index-alias]
  30. include::{docdir}/rest-api/common-parms.asciidoc[tag=index]
  31. [[alias-exists-api-query-params]]
  32. ==== {api-query-parms-title}
  33. include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices]
  34. include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards]
  35. +
  36. Defaults to `all`.
  37. include::{docdir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable]
  38. include::{docdir}/rest-api/common-parms.asciidoc[tag=local]
  39. [[alias-exists-api-response-codes]]
  40. ==== {api-response-codes-title}
  41. `200`::
  42. Indicates all specified index aliases exist.
  43. `404`::
  44. Indicates one or more specified index aliases **do not** exist.
  45. [[alias-exists-api-example]]
  46. ==== {api-examples-title}
  47. [source,js]
  48. ----
  49. HEAD /_alias/2030
  50. HEAD /_alias/20*
  51. HEAD /logs_20302801/_alias/*
  52. ----
  53. // CONSOLE
  54. // TEST[s/^/PUT logs_20302801\nPUT logs_20302801\/_alias\/2030\n/]