스냅샷 저장소 검증 API

스냅샷 저장소 검증 API (Verify Snapshot Repository API)

스냅샷 저장소가 정상 작동하는지 검증해요. 클러스터의 각 노드에서 저장소를 검증해요.

도입 버전 1.0

검증이 성공하면 Verify Snapshot Repository API는 스냅샷 저장소에 연결된 노드 목록을 반환해요. 검증이 실패하면 API는 오류를 반환해요.

Security 플러그인을 사용한다면 manage cluster 권한이 있어야 해요.

GET _snapshot/{repository}/

경로 파라미터는 선택 사항이에요.

파라미터	데이터 타입	설명
repository	String	검증할 저장소의 이름이에요.

파라미터	데이터 타입	설명
cluster_manager_timeout	Time	클러스터 매니저 노드에 연결할 때까지 기다리는 시간이에요. 선택 사항이며 기본값은 30s 예요.
timeout	Time	응답을 기다리는 시간이에요. timeout 값 전에 응답을 받지 못하면 요청은 실패하고 오류를 반환해요. 기본값은 30s 예요.

다음 요청은 my-opensearch-repo가 정상 작동하는지 검증해요:

POST /_snapshot/my-opensearch-repo/_verify?timeout=0s&cluster_manager_timeout=50s

다음 예제는 앞의 예제 요청에 해당하는 응답이에요.

POST /_snapshot/my-opensearch-repo/_verify?timeout=0s&cluster_manager_timeout=50s 요청은 다음 필드를 반환해요:

{
  "nodes" : {
    "by1kztwTRoeCyg4iGU5Y8A" : {
      "name" : "opensearch-node1"
    }
  }
}

위 예제에서는 노드 하나가 스냅샷 저장소에 연결되어 있어요. 더 많은 노드가 연결되어 있다면 응답에서 그 노드들을 볼 수 있어요. 예를 들면:

{
  "nodes" : {
    "lcfL6jv2jo6sMEtp4idMvg" : {
      "name" : "node-1"
    },
    "rEPtFT/B+cuuOHnQn0jy4s" : {
      "name" : "node-2"
  }
}

필드	데이터 타입	설명
nodes	Object	스냅샷 저장소에 연결된 노드 목록(배열이 아님)이에요. 각 노드는 속성이며, 노드 ID가 키이고 이름은 ID(Object)와 name(String)으로 구성돼요.

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

출처: 문서