스냅샷 저장소 조회 API

스냅샷 저장소 조회 API (Get Snapshot Repository API)

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

도입 버전 1.0

저장소에 대해 더 자세히 알아보려면 Register repository를 참고하세요.

스냅샷 생성 중과 생성 후의 세부 정보도 얻을 수 있어요. Get snapshot status를 참고하세요.

엔드포인트

GET /_snapshot/{repository}

경로 파라미터

파라미터	데이터 타입	설명
repository	String	검색할 스냅샷 저장소 이름의 쉼표로 구분된 목록이에요. 와일드카드( * ) 표현식을 지원하며, `-`로 시작하는 제외 패턴과 결합할 수도 있어요.

쿼리 파라미터

파라미터	데이터 타입	설명
local	Boolean	로컬 노드에서 정보를 가져올지 여부예요. 선택 사항이며 기본값은 false 예요.
cluster_manager_timeout	Time	클러스터 매니저 노드에 연결할 때까지 기다리는 시간이에요. 선택 사항이며 기본값은 30초예요.

예제 요청

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

GET /_snapshot/my-opensearch-repo

예제 응답

성공하면 응답이 저장소 정보를 반환해요. 이 예제는 s3 저장소 유형의 응답이에요.

{
  "my-opensearch-repo" : {
    "type" : "s3",
    "settings" : {
      "bucket" : "my-open-search-bucket",
      "base_path" : "snapshots"
    }
  }
}

응답 본문 필드

필드	데이터 타입	설명
type	String	버킷 유형: fs (파일 시스템) 또는 s3 (s3 버킷)
bucket	String	S3 버킷 이름이에요.
base_path	String	스냅샷이 저장되는 버킷 안의 폴더예요.

필요한 권한

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

출처: 문서