ノードのローリング再起動の事前チェック

Prev Next

VPC環境で利用できます。

Cloud Data Streaming Serviceクラスタが Rolling再起動できるかどうかを確認します。

注意

Rolling再起動中にデータ消失や断続的な瞬断が発生する場合があります。

リクエスト

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

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

リクエストヘッダ

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

リクエストボディ

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

フィールド タイプ 必須の有無 説明
serviceGroupInstanceNo Integer Required クラスタインスタンス番号

リクエスト例

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

curl --location --request POST 'https://clouddatastreamingservice.apigw.ntruss.com/api/v1/cluster/rollingRestartPreCheck' \
--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*****
}'

レスポンス

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

レスポンスボディ

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

フィールド タイプ 必須の有無 説明
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": "8f734c6a-****-****-****-656c09f23905"
}

チェックの結果、再起動ドできない場合

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

{
    "code": 3,
    "message": "Invalid Service Group Instance No",
    "result": null,
    "requestId": "5e6de965-****-****-****-5e88ad379d45"
}