CAT 별칭 API

CAT 별칭 API (CAT Aliases API)

1.0 버전에서 도입되었어요. CAT aliases 작업은 별칭에서 인덱스로의 매핑뿐 아니라 라우팅과 필터링 정보를 나열해요.

출처: 문서

본문

엔드포인트 (Endpoints)

GET /_cat/aliases
GET /_cat/aliases/{name}

쿼리 파라미터 (Query parameters)

아래 표는 사용 가능한 쿼리 파라미터를 정리한 거예요. 모든 쿼리 파라미터는 선택 사항이에요.

파라미터 데이터 타입 설명 기본값
expand_wildcards List 또는 String 와일드카드 표현식이 매칭할 수 있는 인덱스 타입. 쉼표로 구분된 값을 지원해요. 유효한 값은: - all: 숨겨진 인덱스를 포함한 모든 인덱스와 매칭. - closed: 닫힌, 숨겨지지 않은 인덱스와 매칭. - hidden: 숨겨진 인덱스와 매칭. open, closed 또는 둘 다와 결합해야 해요. - none: 와일드카드 표현식이 허용되지 않음. - open: 열린, 숨겨지지 않은 인덱스와 매칭. N/A
format String json 또는 yaml 같은 Accept 헤더의 짧은 버전. N/A
h List 표시할 열 이름의 쉼표로 구분된 목록. N/A
help Boolean 도움말 정보를 반환해요. false
local Boolean 클러스터 매니저 노드 대신 로컬 노드에서만 정보를 반환할지 여부. false
s List 정렬 기준이 될 열 이름 또는 열 별칭의 쉼표로 구분된 목록. N/A
v Boolean 열 머리글을 표시하는 자세한(verbose) 모드를 활성화해요. false

예제 요청 (Example requests)

GET /_cat/aliases?v

정보를 특정 별칭으로 제한하려면 쿼리 뒤에 별칭 이름을 추가하세요:

GET /_cat/aliases/<alias>?v

둘 이상의 별칭에 대한 정보를 원한다면 별칭 이름을 쉼표로 구분하세요:

GET /_cat/aliases/alias1,alias2,alias3

예제 응답 (Example response)

다음 응답은 다양한 유형의 별칭 설정을 보여줘요:

alias            | index          | filter | routing.index | routing.search | is_write_index
current-logs     | app-logs-2024  | -      | -             | -              | -
filtered-data    | customer-data  | *      | -             | -              | -
regional-orders  | orders-2024    | -      | west          | west           | -
multi-route      | products       | -      | 1             | 1,2            | -

이 응답이 보여주는 것:

  • current-logs: 필터나 라우팅이 없는 단순한 별칭
  • filtered-data: 설정된 필터가 있는 별칭(*로 표시)
  • regional-orders: 인덱싱과 검색 모두에 라우팅이 설정된 별칭
  • multi-route: 인덱싱(1)과 검색(1,2)에 서로 다른 라우팅이 있는 별칭

인덱스 별칭에 대해 더 알아보려면 Index aliases 문서를, 별칭 관리 API에 대해서는 Alias APIs 문서를 참고하세요.

필요한 권한 (Required permissions)

Security 플러그인을 사용한다면 적절한 권한이 있는지 확인하세요: indices:admin/aliases/get

더 알아보기 (Learn more)