バージョンアップ状態の照会

Prev Next

VPC環境で利用できます。

Search Engine(OpenSearch)クラスタバージョンの Rollingアップグレード進行状態を照会します。

リクエスト

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

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

リクエストヘッダ

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

リクエストボディ

リクエストボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
serviceGroupInstanceNo String Required クラスタインスタンス番号

リクエスト例

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

curl --location --request POST 'https://vpcsearchengine.apigw.ntruss.com/api/v2/cluster/getRollingUpgradeProgress' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \
--data '{
  "serviceGroupInstanceNo": "1037*****"
}'

レスポンス

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

レスポンスボディ

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

フィールド タイプ 必須の有無 説明
code Integer - レスポンスコード
message String - レスポンスメッセージ
result Object - レスポンス結果
result.name String - クラスタ名
result.nodeCount Integer - クラスタの総ノード数
result.versionVo Object - Search Engineバージョン情報
result.versionVo.currentVersionCode String - アップグレード前の Search Engineバージョンコード
result.versionVo.targetVersionCode String - アップグレード後の Search Engineバージョンコード
result.versionVo.actionDate String - 作業日時
  • yyyy-MM-dd HH:mm:ss形式
result.nodeStatusVoList Array - ノード別状態情報
requestId String - リクエスト ID
  • UUID形式

result.nodeStatusVoList

result.nodeStatusVoListの説明は次の通りです。

フィールド タイプ 必須の有無 説明
hostname String - サーバ名
status String - 状態
nodeRoleCode String - ノードタイプコード
  • M | D | DO | MO
    • M: マネージャノード
    • D、DO: データノード
    • MO: マスターノード
updatedDate String - 最終更新日時
  • yyyy-MM-dd HH:mm:ss形式

レスポンスステータスコード

Search Engine Service APIで共通して使用されるレスポンスステータスコードの詳細は、Search Engine Serviceのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "code": 0,
    "message": "SUCCESS",
    "result": {
        "name": "cluster000",
        "nodeCount": 8,
        "versionVo": {
            "currentVersionCode": "2140",
            "targetVersionCode": "2150",
            "actionDate": "2025-03-24 17:09:41"
        },
        "nodeStatusVoList": [
            {
                "hostname": "cluster000-mo-6tnk",
                "status": "complete",
                "nodeRoleCode": "MO",
                "updatedDate": "2025-03-24 17:11:28"
            },
            {
                "hostname": "cluster000-mo-6tnl",
                "status": "Upgrade_OpenSearch",
                "nodeRoleCode": "MO",
                "updatedDate": "2025-03-24 17:11:28"
            },
            {
                "hostname": "cluster000-do-6tnm",
                "status": "running",
                "nodeRoleCode": "DO",
                "updatedDate": "2025-03-24 16:35:53"
            },
            {
                "hostname": "cluster000-do-6tnn",
                "status": "running",
                "nodeRoleCode": "DO",
                "updatedDate": "2025-03-24 16:35:59"
            },
            {
                "hostname": "cluster000-do-6tno",
                "status": "running",
                "nodeRoleCode": "DO",
                "updatedDate": "2025-03-24 16:36:06"
            },
            {
                "hostname": "cluster000-m-6tnh",
                "status": "running",
                "nodeRoleCode": "M",
                "updatedDate": "2025-03-24 16:36:16"
            },
            {
                "hostname": "cluster000-m-6tni",
                "status": "running",
                "nodeRoleCode": "M",
                "updatedDate": "2025-03-24 16:36:21"
            },
            {
                "hostname": "cluster000-mo-6tnj",
                "status": "running",
                "nodeRoleCode": "MO",
                "updatedDate": "2025-03-24 16:36:11"
            }
        ]
    },
    "requestId": "da7b5fcb-****-****-****-63ed6f14d4b1"
}