MENU
      View Rolling Upgrade progress status

        View Rolling Upgrade progress status


        Article summary

        Available in VPC

        Description

        View the Rolling Upgrade progress status.

        Requests

        Request URL

        POST https://vpcsearchengine.apigw.ntruss.com/api/v2/cluster/getRollingUpgradeProgress  [KR]
        POST https://vpcsearchengine.apigw.ntruss.com/api/sgn-v2/cluster/getRollingUpgradeProgress [SGN]
        POST https://vpcsearchengine.apigw.ntruss.com/api/jpn-v2/cluster/getRollingUpgradeProgress [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
        ServiceGroupInstanceNoStringYTarget cluster number

        Request examples

        GET https://vpcsearchengine.apigw.ntruss.com/api/v2/cluster/getRollingUpgradeProgress
        HOST: vpcsearchengine.apigw.ntruss.com
        Content-Type: application/json
        x-ncp-apigw-signature-v2: XFS2MSpvTMQZNVTtvymIzMwNeQ
        x-ncp-apigw-timestamp: 1709704983976
        x-ncp-iam-access-key: ANJNnR1jz1gUzaiS0aV2
        {
          "serviceGroupInstanceNo": "3427188"
        }
        HTTP
        curl -X 'POST' 'https://vpcsearchengine.beta-apigw.ntruss.com/api/v2/cluster/getRollingUpgradeProgress'
          -H 'accept: application/json'
          -H 'Content-Type: application/json'
          -H 'x-ncp-iam-access-key: ANJNnR1jz1gUzaiS0aV2'
          -H 'x-ncp-apigw-timestamp: 1709704983976'
          -H 'x-ncp-apigw-signature-v2: XFS2MSpvTMQZNVTtvymIzMwNeQ/gs3vf1pjgzwOo2g8='
          -d '{
          "serviceGroupInstanceNo": "3427188"
        }'
        Bash

        Responses

        Response parameters

        public class GetRollingUpgradeProgressResponseVo {
            String name;
            Integer nodeCount;
            GetRollingUpgradeHistoryVersionResponseVo versionVo;
            List<NodeServerStatusVo> nodeStatusVoList;
        }
        
        public class GetRollingUpgradeHistoryVersionResponseVo {
            String currentVersionCode;
            String targetVersionCode;
            Date actionDate;
        }
        
        public class NodeServerStatusVo {
            String hostname;
            String status;
            String nodeRoleCode;
            Date updatedDate;
        }
        Java

        Field

        Parameter nameTypeDescription
        nameStringCluster name
        nodeCountintegerNumber of cluster nodes
        versionVoGetRollingUpgradeHistoryVersionResponseVoInformation of upgraded versions
        currentVersionCodeStringCurrent version code before upgrade
        targetVersionCodeStringVersion code after upgrade
        actionDateDateRequest time of version upgrade
        nodeStatusVoListList<NodeServerStatusVo>Status information per node
        hostnameStringHost name of node
        statusStringProgress status
        nodeRoleCodeStringRole type code per node M:Manager, D:Data
        updatedDateDateUpdate time of node progress status

        Response examples

        {
          "code": 0,
          "message": "SUCCESS",
          "result": {
            "name": "sso-test-270",
            "nodeCount": 5,
            "versionVo": {
              "currentVersionCode": "270",
              "targetVersionCode": "290",
              "actionDate": "2024-03-06 15:01:14"
            },
            "nodeStatusVoList": [
              {
                "hostname": "sso-test-270-m-1lv7",
                "status": "running",
                "nodeRoleCode": "M",
                "updatedDate": "2024-03-05 21:14:49"
              },
              {
                "hostname": "sso-test-270-m-1lv8",
                "status": "running",
                "nodeRoleCode": "M",
                "updatedDate": "2024-03-05 21:14:55"
              },
              {
                "hostname": "sso-test-270-d-1lv9",
                "status": "complete",
                "nodeRoleCode": "D",
                "updatedDate": "2024-03-06 15:02:31"
              },
              {
                "hostname": "sso-test-270-d-1lva",
                "status": "Upgrade_OpenSearch",
                "nodeRoleCode": "D",
                "updatedDate": "2024-03-06 15:02:31"
              },
              {
                "hostname": "sso-test-270-d-1lvb",
                "status": "running",
                "nodeRoleCode": "D",
                "updatedDate": "2024-03-05 21:14:44"
              }
            ]
          },
          "requestId": "b250b9b1-96df-4a04-a755-bf7f4bb1b532"
        }
        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.