MENU
      Rolling Upgrade Pre Check

        Rolling Upgrade Pre Check


        Article summary

        Available in VPC

        Description

        Check availability before Rolling Upgrade of OpenSearch Version.

        Note

        RollingUpgrade can proceed only if there is a snapshot created within the previous 6 hours.

        Requests

        Request URL

        POST https://vpcsearchengine.apigw.ntruss.com/api/v2/cluster/rollingUpgradePreCheck [KR]
        POST https://vpcsearchengine.apigw.ntruss.com/api/sgn-v2/cluster/rollingUpgradePreCheck [SGN]
        POST https://vpcsearchengine.apigw.ntruss.com/api/jpn-v2/cluster/rollingUpgradePreCheck [JPN]
        HTTP

        Request headers

        Header nameDescription
        x-ncp-apigw-timestamp- This is the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 (UTC)
        - If the time difference compared to the API Gateway server is more than 5 minutes, the request is considered invalid
        x-ncp-apigw-timestamp:{Timestamp}
        x-ncp-iam-access-keyValue of access key ID issued from NAVER Cloud Platform portal
        x-ncp-iam-access-key:{Account Access Key}
        x-ncp-apigw-signature-v2Signature encrypted with the access key ID value and secret key
        x-ncp-apigw-signature-v2:{API Gateway Signature}
        Content-TypeSpecify the request body content type as application/json
        Content-Type: application/json

        Request parameters

        ParameterTypeRequiredDescription
        targetVersionCodeStringYVersion code of the application to upgrade
        ServiceGroupInstanceNoStringYTarget cluster number

        Request examples

        POST https://vpcsearchengine.apigw.ntruss.com/api/v2/cluster/rollingUpgradePreCheck
        HOST: vpcsearchengine.apigw.ntruss.com
        Content-Type: application/json
        x-ncp-apigw-signature-v2: Qj8Jowjqu3MRMyEk/NKdagftTL/5/VhBJkTv1XKCMGQ=
        x-ncp-apigw-timestamp: 1709700150235
        x-ncp-iam-access-key: ANJNnR1jz1gUzaiS0aV2
        {
          "serviceGroupInstanceNo": "3427188",
          "targetVersionCode": "2111"
        }
        Bash
        curl -X 'POST' \
          'https://vpcsearchengine.beta-apigw.ntruss.com/api/v2/cluster/rollingUpgradePreCheck' \
          -H 'accept: application/json' \
          -H 'Content-Type: application/json' \
          -H 'x-ncp-iam-access-key: ANJNnR1jz1gUzaiS0aV2' \
          -H 'x-ncp-apigw-timestamp: 1709700150235' \
          -H 'x-ncp-apigw-signature-v2: Qj8Jowjqu3MRMyEk/NKdagftTL/5/VhBJkTv1XKCMGQ=' \
          -d '{
          "serviceGroupInstanceNo": "3427188",
          "targetVersionCode": "2111"
        }'
        Bash

        Responses

        Response examples

        If the version upgrade is available

        It is possible to proceed with the following steps.

        {
          "code": 0,
          "message": "SUCCESS",
          "result": true,
          "requestId": "1a8954a8-fd75-46e1-bc73-568e96c6d48c"
        }
        JSON

        If it is necessary to create a snapshot

        It is a case when there is no snapshot created or there is no snapshot created within the previous 6 hours. Create a snapshot in advance.

        {
          "code": 10154,
          "message": "No snapshot created. For cluster upgrade, create a snapshot in advance",
          "result": null,
          "requestId": "305653e0-4bf7-4f8b-8acd-3d719815b273"
        }
        JSON

        If TargetVersionCode is wrong

        After you reconfirm searchEngineVersionCode through getSearchEngineVersionList API, request the upgrade.

        {
          "code": 10154,
          "message": "It is a wrong cluster version. Please reconfirm",
          "result": null,
          "requestId": "305653e0-4bf7-4f8b-8acd-3d719815b273"
        }
        JSON

        Was this article helpful?

        Changing your password will log you out immediately. Use the new password to log back in.
        First name must have atleast 2 characters. Numbers and special characters are not allowed.
        Last name must have atleast 1 characters. Numbers and special characters are not allowed.
        Enter a valid email
        Enter a valid password
        Your profile has been successfully updated.