Pre-check version upgrade

Available in VPC

Check whether rolling upgrades are possible for the Kafka version of a Cloud Data Streaming Service cluster.

Caution

Please note the following when upgrading.

Select the appropriate config group for your version.
If there are topics being replicated, you can proceed after replication is complete.
Upgrade may cause data loss or intermittent interruptions.

Request

This section describes the request format. The method and URI are as follows:

Method	URI
POST	/api/v1/cluster/rollingUpgradePreCheck (Korea Region)
POST	/api/sgn-v1/cluster/rollingUpgradePreCheck (Singapore Region)
POST	/api/jpn-v1/cluster/rollingUpgradePreCheck (Japan Region)

Request headers

For information about the headers common to all Cloud Data Streaming Service APIs, see Cloud Data Streaming Service request headers.

Request body

You can include the following data in the body of your request:

Field	Type	Required	Description
`serviceGroupInstanceNo`	Integer	Required	Cluster instance number See Get cluster list.
`upgradeKafkaVersionCode`	Integer	Required	Kafka version code See Get version.
`upgradeConfigGroupNo`	Integer	Required	Config group number of the upgrade Kafka version See Get config group list. If there is no config group created with the applicable version, Create config group.

Request example

The request example is as follows:

curl --location --request POST 'https://clouddatastreamingservice.apigw.ntruss.com/api/v1/cluster/rollingUpgradePreCheck' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \
--data '{
  "serviceGroupInstanceNo": 1009*****,
  "upgradeKafkaVersionCode": 3903006,
  "upgradeConfigGroupNo": 3**
}'

Response

This section describes the response format.

Response body

The response body includes the following data:

Field	Type	Required	Description
`code`	Integer	-	Response code
`message`	String	-	Response message Upgrade available: `SUCCESS` is displayed. Request syntax error or upgrade unavailable: Failure cause is displayed.
`result`	Boolean	-	Response result `true` \| `null` `true`: succeeded `null`: failed
`requestId`	String	-	ID for the request UUID format

Response status codes

For information about the HTTP status codes common to all Cloud Data Streaming Service APIs, see Cloud Data Streaming Service response status codes.

Response example

The response example is as follows:

If upgrade is possible based on check results

The following is a sample response if the upgrade is available based on the check results.

{
    "code": 0,
    "message": "SUCCESS",
    "result": true,
    "requestId": "38c052b5-****-****-****-36694c7a2ab6"
}

If upgrade is not possible based on check results

The following is a sample response when the upgrade can't be performed based on the check results.

{
    "code": 10153,
    "message": "The updated Kafka version must be later than the current cluster version.",
    "result": null,
    "requestId": "045daefb-****-****-****-1bf0092450ae"
}