Get version

Prev Next

Available in VPC

Get available search engine (ElasticSearch, OpenSearch) versions.

Request

This section describes the request format. The method and URI are as follows:

Method URI
GET /api/v2/cluster/getSearchEngineVersionList (Korea Region)
GET /api/sgn-v2/cluster/getSearchEngineVersionList (Singapore Region)
GET /api/jpn-v2/cluster/getSearchEngineVersionList (Japan Region)

Request headers

For information about the headers common to all Search Engine Service APIs, see Search Engine Service request headers.

Request example

The request example is as follows:

curl --location --request GET 'https://vpcsearchengine.apigw.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}'

Response

This section describes the response format.

Response body

The response body includes the following data:

Field Type Required Description
code Integer - Response code
message String - Response message
result Object - Response result
result.searchEngineVersionList Array - Search engine version list
requestId String - ID for the request
  • UUID format

result.searchEngineVersionList

The following describes result.searchEngineVersionList.

Field Type Required Description
searchEngineVersionCode String - Search engine version code
searchEngineVersionName String - Search engine version name
searchEngineDashboardVersionName String - Search engine dashboard version name
type String - Search engine type

Response status codes

For response status codes common to all Search Engine Service APIs, see Search Engine Service response status codes.

Response example

The response example is as follows:

{
    "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"
}