스냅샷 조회 API

스냅샷 조회 API (Get Snapshot API)

스냅샷에 대한 정보를 검색해요.

도입 버전 1.0

엔드포인트

GET _snapshot/{repository}/{snapshot}/

경로 파라미터

파라미터	데이터 타입	설명
repository	String	검색할 스냅샷이 들어 있는 저장소예요.
snapshot	String	검색할 스냅샷이에요.

쿼리 파라미터

파라미터	데이터 타입	설명
verbose	Boolean	true 면 스냅샷을 만든 OpenSearch 버전, 스냅샷의 시작·종료 시간, 포함된 샤드 수 등 각 스냅샷에 대한 추가 정보를 반환해요. false 면 스냅샷 이름과 포함된 인덱스만 반환해요. 스냅샷이 클라우드 기반 저장소에 속해 있고, blob을 읽을 때마다 비용이나 성능 문제가 되는 경우에 유용해요. 선택 사항이며 기본값은 true 예요.
ignore_unavailable	Boolean	사용할 수 없는(손상되었거나 일시적으로 반환할 수 없는) 스냅샷을 처리하는 방법이에요. true 이고 스냅샷을 사용할 수 없으면 요청이 스냅샷을 반환하지 않아요. false 이고 스냅샷을 사용할 수 없으면 요청이 오류를 반환해요. 선택 사항이며 기본값은 false 예요.

예제 요청

다음 요청은 my-opensearch-repo 저장소에 있는 my-first-snapshot의 정보를 검색해요:

GET /_snapshot/my-opensearch-repo/my-first-snapshot

예제 응답

성공하면 응답이 스냅샷 정보를 반환해요:

{
  "snapshots" : [
    {
      "snapshot" : "my-first-snapshot",
      "uuid" : "3P7Qa-M8RU6l16Od5n7Lxg",
      "version_id" : 136217927,
      "version" : "2.0.1",
      "indices" : [
        ".opensearch-observability",
        ".opendistro-reports-instances",
        ".opensearch-notifications-config",
        "shakespeare",
        ".opendistro-reports-definitions",
        "opensearch_dashboards_sample_data_flights",
        ".kibana_1"
      ],
      "data_streams" : [ ],
      "include_global_state" : true,
      "state" : "SUCCESS",
      "start_time" : "2022-08-11T20:30:00.399Z",
      "start_time_in_millis" : 1660249800399,
      "end_time" : "2022-08-11T20:30:14.851Z",
      "end_time_in_millis" : 1660249814851,
      "duration_in_millis" : 14452,
      "failures" : [ ],
      "shards" : {
        "total" : 7,
        "failed" : 0,
        "successful" : 7
      }
    }
  ]
}

응답 본문 필드

필드	데이터 타입	설명
snapshot	String	스냅샷 이름이에요.
uuid	String	스냅샷의 범용 고유 식별자(UUID)예요.
version_id	Integer	스냅샷을 만든 Open Search 버전의 빌드 ID예요.
version	Float	스냅샷을 만든 Open Search 버전이에요.
indices	Array	스냅샷의 인덱스예요.
data_streams	Array	스냅샷의 데이터 스트림이에요.
include_global_state	Boolean	현재 클러스터 상태가 스냅샷에 포함되는지 여부예요.
start_time	String	스냅샷 생성 프로세스가 시작된 날짜/시간이에요.
start_time_in_millis	Long	스냅샷 생성 프로세스가 시작된 시간(밀리초)이에요.
end_time	String	스냅샷 생성 프로세스가 종료된 날짜/시간이에요.
end_time_in_millis	Long	스냅샷 생성 프로세스가 종료된 시간(밀리초)이에요.
duration_in_millis	Long	스냅샷 생성 프로세스가 지속된 총 시간(밀리초)이에요.
failures	Array	스냅샷 생성 중 발생한 실패가 있다면 그 목록이에요.
shards	Object	생성된 총 샤드 수와 성공·실패한 샤드 수예요.
state	String	스냅샷 상태예요. 가능한 값: IN_PROGRESS , SUCCESS , FAILED , PARTIAL .

필요한 권한

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

출처: 문서