Rolling Upgrade precheck
- Print
- PDF
Rolling Upgrade precheck
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
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]
Request headers
| Header name | Description |
|---|---|
| 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-key | Value of access key ID issued from NAVER Cloud Platform portalx-ncp-iam-access-key:{Account Access Key} |
| x-ncp-apigw-signature-v2 | Signature encrypted with the access key ID value and secret keyx-ncp-apigw-signature-v2:{API Gateway Signature} |
| Content-Type | Specify the request body content type as application/jsonContent-Type: application/json |
Request parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| serviceGroupInstanceNo | Integer | Y | Cluster number to upgrade |
| upgradeKafkaVersionCode | Integer | Y | kafkaVersionCode of higher versions to upgrade |
| upgradeConfigGroupNo | Integer | Y | KafkaconfigGroup 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
}
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
}'
Response examples
{
"code": 0,
"message": "SUCCESS",
"result": true,
"requestId": "ec3559a4-00c8-42c7-ac87-6a60ba4df08e"
}
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"
}
Was this article helpful?