MENU
      Rolling Upgrade precheck

        Rolling Upgrade precheck


        Article summary

        Available in VPC

        Description

        Check availability in advance to upgrade a Kafka version that is being used in the Cloud Data Streaming Service cluster sequentially.

        Caution

        The following describes precautions for upgrading:

        • Select ConfigGroup according to the version.
        • If there is a topic being replicated, it must be resolved to proceed with the following steps.
        • During rolling upgrading, data loss or temporary disconnection may occur.

        Requests

        Request URL

        POST https://clouddatastreamingservice.apigw.ntruss.com/api/v1/cluster/rollingUpgradePreCheck [KR]
        POST https://clouddatastreamingservice.apigw.ntruss.com/api/sgn-v1/cluster/rollingUpgradePreCheck [SGN]
        POST https://clouddatastreamingservice.apigw.ntruss.com/api/jpn-v1/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
        serviceGroupInstanceNoIntegerYCluster number to upgrade
        upgradeKafkaVersionCodeIntegerYkafkaVersionCode of higher versions to upgrade
        upgradeConfigGroupNoIntegerYKafkaconfigGroup number created for kafkaVersion of higher versions to upgrade

        Request examples

        POST https://clouddatastreamingservice.apigw.ntruss.com/api/v1/cluster/rollingUpgradePreCheck
        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,
          "upgradeKafkaVersionCode": 2823006,
          "upgradeConfigGroupNo": 170
        }
        HTTP
        curl -X 'POST' \
          'https://clouddatastreamingservice.beta-apigw.ntruss.com/api/v1/cluster/rollingUpgradePreCheck' \
          -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,
          "upgradeKafkaVersionCode": 2823006,
          "upgradeConfigGroupNo": 170
        }'
        Bash

        Response examples

        {
          "code": 0,
          "message": "SUCCESS",
          "result": true,
          "requestId": "ec3559a4-00c8-42c7-ac87-6a60ba4df08e"
        }
        JSON

        Error response examples

        {
          "code": 10153,
          "message": "the updated Kafka version must be later than the current cluster version.",
          "result": null,
          "requestId": "251afd18-167c-4ce6-9b91-81831013ee88"
        }
        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.