Available in VPC
Restart a Cloud Data Streaming Service cluster using the rolling method. Before restarting, make sure to Check rolling restart availability.
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/rollingRestart (Korea Region) |
POST | /api/sgn-v1/cluster/rollingRestart (Singapore Region) |
POST | /api/jpn-v1/cluster/rollingRestart (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/rollingRestart' \
--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 |
result |
Boolean | - | Response result
|
requestId |
String | - | ID for the request
|
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:
{
"code": 0,
"message": "SUCCESS",
"result": true,
"requestId": "71b0ae2b-****-****-****-3c26b10544cb"
}