alias-exists.asciidoc 1.7 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374
  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. include::{es-repo-dir}/indices/add-alias.asciidoc[tag=index-alias-desc]
  8. [source,console]
  9. ----
  10. HEAD /_alias/alias1
  11. ----
  12. // TEST[setup:my_index]
  13. // TEST[s/^/PUT my-index-000001\/_alias\/alias1\n/]
  14. [[alias-exists-api-request]]
  15. ==== {api-request-title}
  16. `HEAD /_alias/<alias>`
  17. `HEAD /<index>/_alias/<alias>`
  18. [[alias-exists-api-prereqs]]
  19. ==== {api-prereq-title}
  20. * If the {es} {security-features} are enabled, you must have the
  21. `view_index_metadata` or `manage` <<privileges-list-indices,index privilege>>
  22. for the index alias. If you specify an index, you must also have
  23. `view_index_metadata` or `manage` index privilege for the index.
  24. [[alias-exists-api-path-params]]
  25. ==== {api-path-parms-title}
  26. `<alias>`::
  27. (Required, string)
  28. include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-alias]
  29. include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index]
  30. [[alias-exists-api-query-params]]
  31. ==== {api-query-parms-title}
  32. include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards]
  33. +
  34. Defaults to `all`.
  35. include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable]
  36. include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=local]
  37. [[alias-exists-api-response-codes]]
  38. ==== {api-response-codes-title}
  39. `200`::
  40. Indicates all specified index aliases exist.
  41. `404`::
  42. Indicates one or more specified index aliases **do not** exist.
  43. [[alias-exists-api-example]]
  44. ==== {api-examples-title}
  45. [source,console]
  46. ----
  47. HEAD /_alias/2030
  48. HEAD /_alias/20*
  49. HEAD /logs_20302801/_alias/*
  50. ----
  51. // TEST[s/^/PUT logs_20302801\nPUT logs_20302801\/_alias\/2030\n/]