클러스터 정보 API

클러스터 정보 API (Cluster Information API)

클러스터에 실제로 접속이 되는지, 버전은 몇인지 가장 간단하게 확인하고 싶으시죠? 클러스터 정보 API(/)가 실행 중인 OpenSearch 클러스터와 노드에 대한 정보를 반환해요. 버전, 빌드 세부 정보, 클러스터 이름이 포함돼요. 클러스터가 연결 가능한지 확인하고 OpenSearch 버전을 알아내는 가장 간단한 방법이에요.

출처: 문서

본문

1.0에서 도입

클러스터 정보 API(/)는 버전, 빌드 세부 정보, 클러스터 이름을 포함해 실행 중인 OpenSearch 클러스터와 노드에 대한 정보를 검색해요. 이는 클러스터가 연결 가능한지 확인하고 OpenSearch 버전을 알아내는 가장 간단한 방법이에요.

엔드포인트

GET /
HEAD /

• GET /은 클러스터와 버전 세부 정보를 포함한 JSON 본문을 반환해요.
• HEAD /는 HTTP 상태만(연결 가능하면 200) 반환해요. 가벼운 상태 확인에 유용해요.

예시 요청

클러스터의 버전과 빌드 정보를 얻으려면 다음 요청을 보내요.

GET /

예시 응답

{
  "name": "opensearch-node1",
  "cluster_name": "opensearch-cluster",
  "cluster_uuid": "sQj1b9cZQICv0b8iYc3y5A",
  "version": {
    "distribution": "opensearch",
    "number": "3.2.0",
    "build_type": "tar",
    "build_hash": "abc123def456",
    "build_date": "2025-06-18T12:34:56.000Z",
    "build_snapshot": false,
    "lucene_version": "9.10.0",
    "minimum_wire_compatibility_version": "7.10.0",
    "minimum_index_compatibility_version": "7.0.0"
  },
  "tagline": "The OpenSearch Project: https://opensearch.org/"
}

응답 본문 필드

더 알아보기 (Learn more)

• HEAD /는 경량 상태 확인에 유용해요.
• version 객체는 업그레이드 전 호환성 확인에 유용한 정보를 제공해요.