인덱스 별칭 존재 확인 API
인덱스 별칭 존재 확인 API (Index Alias Exists API)
1.0 버전에서 도입되었어요. 지정한 별칭(alias)이 실제로 존재하는지 확인하는 API예요.
출처: 문서
본문
엔드포인트 (Endpoints)
HEAD /_alias/{alias}
HEAD /{index}/_alias/{alias}
경로 파라미터 (Path parameters)
아래 표는 사용 가능한 경로 파라미터를 정리한 거예요. 모든 경로 파라미터는 필수예요.
| 파라미터 | 데이터 타입 | 설명 |
|---|---|---|
<alias> |
String | 확인할 별칭 이름의 쉼표로 구분된 목록 또는 와일드카드 표현식. |
<index> |
String | 요청 범위를 제한하는 데 사용하는 인덱스 이름의 쉼표로 구분된 목록 또는 와일드카드 표현식. |
쿼리 파라미터 (Query parameters)
아래 표는 사용 가능한 쿼리 파라미터를 정리한 거예요. 모든 쿼리 파라미터는 선택 사항이에요.
| 파라미터 | 데이터 타입 | 설명 |
|---|---|---|
expand_wildcards |
String | 와일드카드 표현식이 매칭할 수 있는 인덱스 타입. 쉼표로 구분된 값을 지원해요. 유효한 값은 all, open, closed, hidden, none이에요. 기본값은 all이에요. |
ignore_unavailable |
Boolean | 사용할 수 없는 인덱스를 무시할지 여부. 기본값은 false예요. |
local |
Boolean | 클러스터 매니저 노드 대신 로컬 노드에서만 정보를 반환할지 여부. 기본값은 false예요. |
응답 코드 (Response codes)
이 API는 다음 응답 코드 중 하나를 반환해요.
| 응답 코드 | 설명 |
|---|---|
| 200 | 지정한 모든 별칭이 존재함을 나타내요. |
| 404 | 지정한 별칭 중 하나 이상이 존재하지 않음을 나타내요. |
예제 요청 (Example requests)
다음 요청은 2030이라는 별칭이 존재하는지 확인해요:
HEAD /_alias/2030
필요한 권한 (Required permissions)
Security 플러그인을 사용한다면 적절한 권한이 있는지 확인하세요: indices:admin/aliases/get
관련 문서 (Related documentation)
인덱스 별칭에 대한 자세한 내용은 Index aliases 문서를 참고하세요.