Pre-check node rolling restart

Prev Next

Available in VPC

Check whether rolling restart is possible for a Cloud Data Streaming Service cluster.

Caution

Rolling restart 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/rollingRestartPreCheck (Korea Region)
POST /api/sgn-v1/cluster/rollingRestartPreCheck (Singapore Region)
POST /api/jpn-v1/cluster/rollingRestartPreCheck (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

Request example

The request example is as follows:

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

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
  • Restart available: SUCCESS is displayed.
  • Request syntax error or restart 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 restart is possible based on check results

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

{
    "code": 0,
    "message": "SUCCESS",
    "result": true,
    "requestId": "8f734c6a-****-****-****-656c09f23905"
}

If restart is not possible based on check results

The following is a sample response if the restart is unavailable based on the check results.

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