CAT 세그먼트 API

CAT 세그먼트 API (CAT Segments API)

1.0 버전에서 도입되었어요. CAT segments 작업은 각 인덱스의 Lucene 세그먼트 수준 정보를 나열해요.

출처: 문서

본문

엔드포인트 (Endpoints)

GET /_cat/segments
GET /_cat/segments/{index}

쿼리 파라미터 (Query parameters)

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

파라미터 데이터 타입 설명 기본값
bytes String 바이트 값을 표시하는 데 사용하는 단위. 유효한 값은 b, kb, k, mb, m, gb, g, tb, t, pb, p예요. N/A
cluster_manager_timeout String 클러스터 매니저 노드에 연결하는 데 허용되는 시간. N/A
format String json 또는 yaml 같은 Accept 헤더의 짧은 버전. N/A
h List 표시할 열 이름의 쉼표로 구분된 목록. N/A
help Boolean 도움말 정보를 반환해요. false
s List 정렬 기준이 될 열 이름 또는 열 별칭의 쉼표로 구분된 목록. N/A
v Boolean 열 머리글을 표시하는 자세한(verbose) 모드를 활성화해요. false

예제 요청 (Example requests)

GET /_cat/segments?v

특정 인덱스의 세그먼트 정보만 보려면 쿼리 뒤에 인덱스 이름을 추가하세요.

GET /_cat/segments/<index>?v

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

GET /_cat/segments/index1,index2,index3

예제 응답 (Example response)

index | shard | prirep | ip | segment | generation | docs.count | docs.deleted | size | size.memory | committed | searchable | version | compound
movies | 0 | p | 172.18.0.4 | _0 | 0 | 1 | 0 | 3.5kb | 1364 | true | true | 8.7.0 | true
movies | 0 | r | 172.18.0.3 | _0 | 0 | 1 | 0 | 3.5kb | 1364 | true | true | 8.7.0 | true

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

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

필요한 권한 (Required permissions)

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

더 알아보기 (Learn more)