バージョンの照会

Prev Next

VPC環境で利用できます。

使用可能な Search Engine(ElasticSearch、OpenSearch)バージョンを照会します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド URI
GET /api/v2/cluster/getSearchEngineVersionList (韓国リージョン)
GET /api/sgn-v2/cluster/getSearchEngineVersionList (シンガポールリージョン)
GET /api/jpn-v2/cluster/getSearchEngineVersionList (日本リージョン)

リクエストヘッダ

Search Engine Service APIで共通して使用されるヘッダの詳細は、Search Engine Serviceのリクエストヘッダをご参照ください。

リクエスト例

リクエストのサンプルコードは次の通りです。

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}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
code Integer - レスポンスコード
message String - レスポンスメッセージ
result Object - レスポンス結果
result.searchEngineVersionList Array - Search Engineバージョンリスト
requestId String - リクエスト ID
  • 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"
}