alias.asciidoc 1.3 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758
  1. [[cat-alias]]
  2. == cat aliases
  3. `aliases` shows information about currently configured aliases to indices
  4. including filter and routing infos.
  5. ////
  6. Hidden setup for example:
  7. [source,js]
  8. --------------------------------------------------
  9. PUT test1
  10. {
  11. "aliases": {
  12. "alias1": {},
  13. "alias2": {
  14. "filter": {
  15. "match": {
  16. "user": "kimchy"
  17. }
  18. }
  19. },
  20. "alias3": {
  21. "routing": "1"
  22. },
  23. "alias4": {
  24. "index_routing": "2",
  25. "search_routing": "1,2"
  26. }
  27. }
  28. }
  29. --------------------------------------------------
  30. // CONSOLE
  31. ////
  32. [source,js]
  33. --------------------------------------------------
  34. GET /_cat/aliases?v
  35. --------------------------------------------------
  36. // CONSOLE
  37. // TEST[continued]
  38. Might respond with:
  39. [source,txt]
  40. --------------------------------------------------
  41. alias index filter routing.index routing.search
  42. alias1 test1 - - -
  43. alias2 test1 * - -
  44. alias3 test1 - 1 1
  45. alias4 test1 - 2 1,2
  46. --------------------------------------------------
  47. // TESTRESPONSE[s/[*]/[*]/ _cat]
  48. The output shows that `alias2` has configured a filter, and specific routing
  49. configurations in `alias3` and `alias4`.
  50. If you only want to get information about a single alias, you can specify
  51. the alias in the URL, for example `/_cat/aliases/alias1`.