CAT 인덱스 API

CAT 인덱스 API (CAT Indices API)

1.0 버전에서 도입되었어요. CAT indices 작업은 인덱스 관련 정보, 즉 얼마나 많은 디스크 공간을 사용하는지, 샤드가 몇 개인지, 헬스 상태가 어떤지 등을 나열해요.

출처: 문서

본문

엔드포인트 (Endpoints)

GET /_cat/indices
GET /_cat/indices/{index}

쿼리 파라미터 (Query parameters)

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

파라미터 데이터 타입 설명 기본값
bytes String 바이트 값을 표시하는 데 사용하는 단위. 유효한 값은 b, kb, k, mb, m, gb, g, tb, t, pb, p예요. N/A
cluster_manager_timeout String 클러스터 매니저 노드에 연결하는 데 허용되는 시간. N/A
expand_wildcards List 또는 String 와일드카드 표현식이 매칭할 수 있는 인덱스 타입. 쉼표로 구분된 값을 지원해요. 유효한 값은: - all: 숨겨진 인덱스를 포함한 모든 인덱스와 매칭. - closed: 닫힌, 숨겨지지 않은 인덱스와 매칭. - hidden: 숨겨진 인덱스와 매칭. open, closed 또는 둘 다와 결합해야 해요. - none: 와일드카드 표현식이 허용되지 않음. - open: 열린, 숨겨지지 않은 인덱스와 매칭. N/A
format String json 또는 yaml 같은 Accept 헤더의 짧은 버전. N/A
h List 표시할 열 이름의 쉼표로 구분된 목록. N/A
health String 헬스 상태를 기준으로 인덱스를 제한해요. 지원되는 값은 green, yellow, red예요. 유효한 값은 green, GREEN, yellow, YELLOW, red, RED예요. N/A
help Boolean 도움말 정보를 반환해요. false
include_unloaded_segments Boolean 메모리에 로드되지 않은 세그먼트의 정보를 포함할지 여부. false
local Boolean 로컬 정보를 반환하지만 클러스터 매니저 노드에서 상태를 가져오지 않아요. false
pri Boolean true면 기본(primary) 샤드에서만 정보를 반환해요. false
s List 정렬 기준이 될 열 이름 또는 열 별칭의 쉼표로 구분된 목록. N/A
time String 시간 단위를 지정해요. 유효한 값은 nanos, micros, ms, s, m, h, d예요. N/A
v Boolean 열 머리글을 표시하는 자세한(verbose) 모드를 활성화해요. false

예제 요청 (Example requests)

GET /_cat/indices?v

정보를 특정 인덱스로 제한하려면 쿼리 뒤에 인덱스 이름을 추가하세요.

GET /_cat/indices/<index>?v

둘 이상의 인덱스에 대한 정보를 원한다면 인덱스를 쉼표로 구분하세요:

GET /_cat/indices/index1,index2,index3

예제 응답 (Example response)

health | status | index | uuid | pri | rep | docs.count | docs.deleted | store.size | pri.store.size
green  | open | movies | UZbpfERBQ1-3GSH2bnM3sg | 1 | 1 | 1 | 0 | 7.7kb | 3.8kb

응답 크기 제한 (Limiting the response size)

반환되는 인덱스 수를 제한하려면 cat.indices.response.limit.number_of_indices 설정을 구성하세요. 자세한 내용은 Cluster-level CAT response limit settings 문서를 참고하세요.

필요한 권한 (Required permissions)

Security 플러그인을 사용한다면 적절한 권한이 있는지 확인하세요: indices:monitor/stats와 cluster:monitor/state

더 알아보기 (Learn more)