CAT 스냅샷 API
CAT 스냅샷 API (CAT Snapshots API)
1.0 버전에서 도입되었어요. CAT snapshots 작업은 리포지토리의 모든 스냅샷을 나열해요.
출처: 문서
본문
엔드포인트 (Endpoints)
GET /_cat/snapshots
GET /_cat/snapshots/{repository}
쿼리 파라미터 (Query parameters)
아래 표는 사용 가능한 쿼리 파라미터를 정리한 거예요.
| 파라미터 | 데이터 타입 | 설명 | 기본값 |
|---|---|---|---|
repository |
List 또는 String | (필수) 요청 범위를 제한하는 데 사용하는 스냅샷 리포지토리의 쉼표로 구분된 목록. 와일드카드 표현식을 허용해요. _all은 모든 리포지토리를 반환해요. 요청 중 리포지토리 하나라도 실패하면 OpenSearch는 오류를 반환해요. |
N/A |
cluster_manager_timeout |
String | 클러스터 매니저 노드에 연결하는 데 허용되는 시간. | N/A |
format |
String | json 또는 yaml 같은 Accept 헤더의 짧은 버전. |
N/A |
h |
List | 표시할 열 이름의 쉼표로 구분된 목록. | N/A |
help |
Boolean | 도움말 정보를 반환해요. | false |
ignore_unavailable |
Boolean | true면 응답에 사용할 수 없는 스냅샷의 정보가 포함되지 않아요. |
false |
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/snapshots?v
예제 응답 (Example response)
index | shard | prirep | state | docs | store | ip | | node
plugins | 0 | p | STARTED | 0 | 208b | 172.18.0.4 | odfe-node1
plugins | 0 | r | STARTED | 0 | 208b | 172.18.0.3 | odfe-node2
필요한 권한 (Required permissions)
Security 플러그인을 사용한다면 적절한 권한이 있는지 확인하세요: cluster:admin/snapshot/get