CAT 헬스 API

CAT 헬스 API (CAT Health API)

1.0 버전에서 도입되었어요. CAT health 작업은 클러스터의 상태, 클러스터가 가동된 기간, 노드 수, 그리고 클러스터의 건강 상태를 분석하는 데 도움이 되는 기타 유용한 정보를 나열해요.

출처: 문서

본문

엔드포인트 (Endpoints)

GET /_cat/health

쿼리 파라미터 (Query parameters)

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

파라미터 데이터 타입 설명 기본값
format String json 또는 yaml 같은 Accept 헤더의 짧은 버전. N/A
h List 표시할 열 이름의 쉼표로 구분된 목록. N/A
help Boolean 도움말 정보를 반환해요. false
s List 정렬 기준이 될 열 이름 또는 열 별칭의 쉼표로 구분된 목록. N/A
time String 시간 값을 표시하는 데 사용하는 단위. 유효한 값은 nanos, micros, ms, s, m, h, d예요. N/A
ts Boolean true면 HH:MM:SS와 Unix epoch 타임스탬프를 반환해요. true
v Boolean 열 머리글을 표시하는 자세한(verbose) 모드를 활성화해요. false

예제 요청 (Example request)

다음 예제 요청은 지난 5일 동안의 클러스터 헬스 정보를 제공해요:

GET /_cat/health?v&time=5d

예제 응답 (Example response)

GET _cat/health?v&time=5d

epoch | timestamp | cluster | status | node.total | node.data | shards | pri | relo | init | unassign | pending_tasks | max_task_wait_time | active_shards_percent
1624248112 | 04:01:52 | odfe-cluster | green | 2 | 2 | 16 | 8 | 0 | 0 | 0 | 0 | - | 100.0%

필요한 권한 (Required permissions)

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

더 알아보기 (Learn more)