CAT 리커버리 API

CAT 리커버리 API (CAT Recovery API)

1.0 버전에서 도입되었어요. CAT recovery 작업은 완료되었거나 진행 중인 모든 인덱스와 샤드 리커버리를 나열해요.

출처: 문서

본문

엔드포인트 (Endpoints)

GET /_cat/recovery
GET /_cat/recovery/{index}

쿼리 파라미터 (Query parameters)

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

파라미터 데이터 타입 설명 기본값
active_only Boolean true면 응답에 진행 중인 샤드 리커버리만 포함돼요. false
bytes String 바이트 값을 표시하는 데 사용하는 단위. 유효한 값은 b, kb, k, mb, m, gb, g, tb, t, pb, p예요. N/A
detailed Boolean true면 샤드 리커버리에 대한 자세한 정보를 포함해요. false
format String json 또는 yaml 같은 Accept 헤더의 짧은 버전. N/A
h List 표시할 열 이름의 쉼표로 구분된 목록. N/A
help Boolean 도움말 정보를 반환해요. false
index List 요청 범위를 제한하는 데 사용하는 데이터 스트림, 인덱스, 별칭의 쉼표로 구분된 목록. 와일드카드(*)를 지원해요. 모든 데이터 스트림과 인덱스를 대상으로 하려면 이 파라미터를 생략하거나 * 또는 _all을 사용하세요. 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 requests)

GET /_cat/recovery?v

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

GET /_cat/recovery/<index>?v

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

GET /_cat/recovery/index1,index2,index3

예제 응답 (Example response)

index | shard | time | type | stage | source_host | source_node | target_host | target_node | repository | snapshot | files | files_recovered | files_percent | files_total | bytes | bytes_recovered | bytes_percent | bytes_total | translog_ops | translog_ops_recovered | translog_ops_percent
movies | 0 | 117ms | empty_store | done | n/a | n/a | 172.18.0.4 | odfe-node1 | n/a | n/a | 0 | 0 | 0.0% | 0 | 0 | 0 | 0.0% | 0 | 0 | 0 | 100.0%
movies | 0 | 382ms | peer | done | 172.18.0.4 | odfe-node1 | 172.18.0.3 | odfe-node2 | n/a | n/a | 1 | 1 |  100.0% | 1 | 208 | 208 | 100.0% | 208 | 1 | 1 | 100.0%

필요한 권한 (Required permissions)

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

더 알아보기 (Learn more)