バージョンアップ事前チェック

Prev Next

VPC環境で利用できます。

Cloud Data Streaming Serviceクラスタ Kafkaバージョンは Rollingアップグレード可能かどうかを確認します。

注意

アップグレード時は次の点にご注意ください。

  • バージョンに合った Config Groupを選択してください。
  • レプリケーション中のトピックがある場合、レプリケーションが完了するまで実行できません。
  • アップグレード中にデータ消失や断続的な瞬断が発生する場合があります。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド URI
POST /api/v1/cluster/rollingUpgradePreCheck (韓国リージョン)
POST /api/sgn-v1/cluster/rollingUpgradePreCheck (シンガポールリージョン)
POST /api/jpn-v1/cluster/rollingUpgradePreCheck (日本リージョン)

リクエストヘッダ

Cloud Data Streaming Service APIで共通して使用されるヘッダの詳細は、Cloud Data Streaming Serviceのリクエストヘッダをご参照ください。

リクエストボディ

リクエストボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
serviceGroupInstanceNo Integer Required クラスタインスタンス番号
upgradeKafkaVersionCode Integer Required Kafkaバージョンコード
upgradeConfigGroupNo Integer Required アップグレード Kafkaバージョンの Config Group番号

リクエスト例

リクエストのサンプルコードは次の通りです。

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**
}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
code Integer - レスポンスコード
message String - レスポンスメッセージ
  • アップグレード可能: SUCCESSと表示
  • リクエスト構文にエラーがあるか、アップグレードができない: 失敗の理由を表示
result Boolean - レスポンス結果
  • true | null
    • true: 成功
    • null: 失敗
requestId String - リクエスト ID
  • UUID形式

レスポンスステータスコード

Cloud Data Streaming Service APIで共通して使用されるレスポンスステータスコードの詳細は、Cloud Data Streaming Serviceのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

チェックの結果、アップグレードできる場合

チェックの結果、アップグレードできる場合のレスポンスのサンプルコードは次の通りです。

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

チェックの結果、アップグレードできない場合

チェックの結果、アップグレードできない場合のレスポンスのサンプルコードは次の通りです。

{
    "code": 10153,
    "message": "更新された Kafkaのバージョンは現在のクラスタのバージョン以降にします。",
    "result": null,
    "requestId": "045daefb-****-****-****-1bf0092450ae"
}