버전 조회

Prev Next

VPC 환경에서 이용 가능합니다.

사용할 수 있는 Search Engine(ElasticSearch, OpenSearch) 버전을 조회합니다.

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

메서드 URI
GET /api/v2/cluster/getSearchEngineVersionList (수도권)
GET /api/krs-v2/cluster/cluster/getSearchEngineVersionList (남부권)

요청 헤더

Search Engine Service API에서 공통으로 사용하는 헤더에 대한 정보는 Search Engine Service 요청 헤더를 참조해 주십시오.

요청 예시

요청 예시는 다음과 같습니다.

curl --location --request GET 'https://vpcsearchengine.apigw.gov-ntruss.com/api/v2/cluster/getSearchEngineVersionList' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' 

응답

응답 형식을 설명합니다.

응답 바디

응답 바디에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
code Integer - 응답 코드
message String - 응답 메시지
result Object - 응답 결과
result.searchEngineVersionList Array - Search Engine 버전 목록
requestId String - 요청에 대한 아이디
  • UUID 형식

result.searchEngineVersionList

result.searchEngineVersionList에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
searchEngineVersionCode String - Search Engine 버전 코드
searchEngineVersionName String - Search Engine 버전 이름
searchEngineDashboardVersionName String - Search Engine 대시보드 버전 이름
type String - Search Engine 타입

응답 상태 코드

Search Engine Service API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Search Engine Service 응답 상태 코드를 참조해 주십시오.

응답 예시

응답 예시는 다음과 같습니다.

{
    "code": 0,
    "message": "SUCCESS",
    "result": {
        "searchEngineVersionList": [
            {
                "searchEngineVersionCode": "2140",
                "searchEngineVersionName": "OpenSearch 2.14.0",
                "searchEngineDashboardVersionName": "OpenSearch Dashboard 2.14.0",
                "type": "OpenSearch"
            },
            {
                "searchEngineVersionCode": "2111",
                "searchEngineVersionName": "OpenSearch 2.11.1",
                "searchEngineDashboardVersionName": "OpenSearch Dashboard 2.11.1",
                "type": "OpenSearch"
            },
            {
                "searchEngineVersionCode": "290",
                "searchEngineVersionName": "OpenSearch 2.9.0",
                "searchEngineDashboardVersionName": "OpenSearch Dashboard 2.9.0",
                "type": "OpenSearch"
            },
            {
                "searchEngineVersionCode": "270",
                "searchEngineVersionName": "OpenSearch 2.7.0",
                "searchEngineDashboardVersionName": "OpenSearch Dashboard 2.7.0",
                "type": "OpenSearch"
            },
            {
                "searchEngineVersionCode": "133",
                "searchEngineVersionName": "OpenSearch 1.3.3",
                "searchEngineDashboardVersionName": "OpenSearch Dashboard 1.3.3",
                "type": "OpenSearch"
            },
            {
                "searchEngineVersionCode": "770",
                "searchEngineVersionName": "ElasticSearch-OSS 7.7.0",
                "searchEngineDashboardVersionName": "Kibana-OSS 7.7.0",
                "type": "ElasticSearch-OSS"
            }
        ]
    },
    "requestId": "9e21aa88-****-****-****-b96f6464d631"
}