CAT 작업 API

CAT 작업 API (CAT Tasks API)

1.0 버전에서 도입되었어요. CAT tasks 작업은 클러스터에서 현재 실행 중인 모든 작업의 진행 상황을 나열해요.

출처: 문서

본문

엔드포인트 (Endpoints)

GET /_cat/tasks

쿼리 파라미터 (Query parameters)

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

파라미터 데이터 타입 설명 기본값
actions List 응답 범위를 제한하는 데 사용하는 작업 액션 이름. N/A
detailed Boolean true면 응답에 샤드 리커버리에 대한 자세한 정보가 포함돼요. false
format String json 또는 yaml 같은 Accept 헤더의 짧은 버전. N/A
h List 표시할 열 이름의 쉼표로 구분된 목록. N/A
help Boolean 도움말 정보를 반환해요. false
nodes List 반환되는 정보를 제한하는 데 사용하는 노드 ID 또는 이름의 쉼표로 구분된 목록. 연결 중인 노드의 정보를 반환하려면 _local을, 정보를 가져올 특정 노드를 지정하거나, 모든 노드의 정보를 얻으려면 파라미터를 비워 두세요. N/A
parent_task_id String 응답 범위를 제한하는 데 사용하는 상위 작업 식별자. N/A
s List 정렬 기준이 될 열 이름 또는 열 별칭의 쉼표로 구분된 목록. N/A
time String 시간 단위를 지정해요. 예: 5d 또는 7h. 자세한 내용은 Supported units 문서를 참고하세요. 유효한 값은 nanos, micros, ms, s, m, h, d예요. N/A
v Boolean 열 머리글을 표시하는 자세한(verbose) 모드를 활성화해요. false

예제 요청 (Example request)

다음 예제 요청은 진행 중인 모든 작업을 나열해요:

GET /_cat/tasks?v

예제 응답 (Example response)

action | task_id | parent_task_id | type | start_time | timestamp | running_time | ip | node
cluster:monitor/tasks/lists | 1vo54NuxSxOrbPEYdkSF0w:168062 | - | transport | 1624337809471 | 04:56:49 | 489.5ms | 172.18.0.4 | odfe-node1

필요한 권한 (Required permissions)

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

더 알아보기 (Learn more)