View Rolling Upgrade progress status
    • PDF

    View Rolling Upgrade progress status

    • PDF

    Article summary

    Available in VPC

    Description

    View the cluster progress status during rolling upgrading of the Cloud Data Streaming Service.

    Requests

    Request URL

    POST https://clouddatastreamingservice.apigw.ntruss.com/api/v1/cluster/rollingUpgradeProgressCheck [KR]
    POST https://clouddatastreamingservice.apigw.ntruss.com/api/sgn-v1/cluster/rollingUpgradeProgressCheck [SGN]
    POST https://clouddatastreamingservice.apigw.ntruss.com/api/jpn-v1/cluster/rollingUpgradeProgressCheck [JPN]
    

    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
    serviceGroupInstanceNoIntegerYCluster number to view the upgrade status

    Request examples

    POST https://clouddatastreamingservice.apigw.ntruss.com/api/v1/cluster/rollingUpgradeProgressCheck
    HOST: clouddatastreamingservice.apigw.ntruss.com
    Content-Type: application/json
    x-ncp-apigw-signature-v2: fC/exK+2vx8RSdIWAOePNakOOCp3BO3qy8XHzso15gI=
    x-ncp-apigw-timestamp: 1709716893293
    x-ncp-iam-access-key: ANJNnR1jz1gUzaiS0aV2
    {
      "serviceGroupInstanceNo": 3432149
    }
    
    curl -X 'POST' \
      'https://clouddatastreamingservice.beta-apigw.ntruss.com/api/v1/cluster/rollingUpgradeProgressCheck' \
      -H 'accept: application/json' \
      -H 'Content-Type: application/json' \
      -H 'x-ncp-iam-access-key: ANJNnR1jz1gUzaiS0aV2' \
      -H 'x-ncp-apigw-timestamp: 1709716893293' \
      -H 'x-ncp-apigw-signature-v2: fC/exK+2vx8RSdIWAOePNakOOCp3BO3qy8XHzso15gI=' \
      -d '{
      "serviceGroupInstanceNo": 3432149
    }'
    

    Responses

    Response parameters

    public class GetClusterStatusPerNodeResponseVo {
        String clusterName;
        Integer brokerNodeTotalNumber;
        String brokerStatus;
        List<ProcessStatusVo> brokerStatusPerNode;
        Integer zookeeperTotalNumber;
        String zookeeperStatus;
        List<ProcessStatusVo> zookeeperStatusPerNode;
        String cmakStatus;
    }
    public class ProcessStatusVo {
        String hostname;
        String status;
    }
    
    

    Field

    Parameter nameTypeDescription
    clusterNameStringCluster name
    brokerNodeTotalNumberIntegerTotal number of broker nodes
    brokerStatusStringOverall status average of broker nodes
    brokerStatusPerNodeList<ProcessStatusVo>Lists of broker nodes details
    zookeeperTotalNumberIntegerTotal number of zookeeper nodes
    zookeeperStatusStringOverall status average of zookeeper nodes
    zookeeperStatusPerNodeList<ProcessStatusVo>Lists of zookeeper nodes details
    cmakStatusStringCMAK service status
    ProcessStatusVo<hostname>StringHost name of nodes
    ProcessStatusVo<status>StringDetailed status of nodes

    Response examples

    {
      "code": 0,
      "message": "SUCCESS",
      "result": {
        "clusterName": "upgrade",
        "brokerNodeTotalNumber": 3,
        "brokerNumber": 0,
        "brokerStatus": "green",
        "brokerStatusPerNode": [
          {
            "hostname": "upgrade-b-1m11",
            "status": "changing"
          },
          {
            "hostname": "upgrade-b-1m12",
            "status": "orange"
          },
          {
            "hostname": "upgrade-b-1m13",
            "status": "changing"
          }
        ],
        "zookeeperTotalNumber": 3,
        "zookeeperNumber": 3,
        "zookeeperStatus": "green",
        "zookeeperStatusPerNode": [
          {
            "hostname": "upgrade-b-1m11",
            "status": "green"
          },
          {
            "hostname": "upgrade-b-1m12",
            "status": "green"
          },
          {
            "hostname": "upgrade-b-1m13",
            "status": "green"
          }
        ],
        "cmakStatus": "green"
      },
      "requestId": "5c2d117d-8d3e-41a3-bb95-95a58d4caa0d"
    }
    

    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.