rebootCloudDBServerInstance

Overview

Restarts a Cloud DB instance.

Request

Request header

Request body

Field names in the request body are case sensitive.

• cloudDBServerInstanceNo
  • Cloud DB instance number to restart
• isWithFailover
  • Specify whether to enable failover when a Cloud DB server instance is restarted.
  • This feature is only supported in Cloud DB for MSSQL.
• isRebootNow
  • Restarts a Cloud DB server instance now.
  • This feature is only supported in Cloud DB for MSSQL.
• rebootTime
  • Specify the time to restart.
  • If isRebootNow is true, it will be ignored.
• responseFormatType
  • Response format. Select between xml and json.

Response

Examples

Request example

curl 
-X POST "https://ncloud.apigw.ntruss.com/clouddb/v2/rebootCloudDBServerInstance" 
-H "accept: application/json" 
-H "Content-Type: application/x-www-form-urlencoded" 
-H "x-ncp-apigw-api-key: 25bpuog9sz" 
-H "x-ncp-iam-access-key: Y0Z9EG0lKoeWAQCSHRtM" 
-H "x-ncp-apigw-timestamp: 1545985225769" 
-H "x-ncp-apigw-signature-v2: 02nKI6bFUflXeKwp05zeN1maVbymCAFsyXRubAxxNzk=" 
-d "cloudDBServerInstanceNo=882618&isRebootNow=true&responseFormatType=json"

https://ncloud.apigw.ntruss.com/clouddb/v2/rebootCloudDBServerInstance

Request sample

• Check the instance number and restart the server.

{
  "cloudDBServerInstanceNo": "882618",
  "isRebootNow": true,
  "responseFormatType": "json"
}

Response example

connection: keep-alive 
content-type: application/json;charset=UTF-8 
date: Mon, 24 Dec 2018 08:59:40 GMT 
server: nginx 
transfer-encoding: chunked 
x-ncp-trace-id: 6acpi6di6apj536ob5cksjcor2 

{
  "rebootCloudDBServerInstanceResponse": {
    "returnCode": "0",
    "returnMessage": "success",
    "totalRows": 1,
    "cloudDBInstanceList": [
      {
        "cloudDBInstanceNo": "882617",
        "cloudDBServiceName": "test",
        "dbKindCode": "MYSQL",
        "engineVersion": "MYSQL5.7.19",
        "cpuCount": 2,
        "dataStorageType": {
          "code": "SSD",
          "codeName": "SSD"
        },
        "licenseCode": "GPL",
        "cloudDBPort": 3306,
        "isHa": true,
        "backupTime": "10:30",
        "backupFileRetentionPeriod": 1,
        "cloudDBInstanceStatusName": "restarting",
        "collation": "",
        "createDate": "2018-12-28T14:37:00+0900",
        "cloudDBImageProductCode": "SPSWMYSQLLINUX01",
        "cloudDBProductCode": "SPSVRDBAAS000001",
        "isCloudDBConfigNeedReboot": false,
        "isCloudDBNeedReboot": false,
        "zone": {
          "zoneNo": "2",
          "zoneName": "KR-1",
          "zoneCode": "KR-1",
          "zoneDescription": "Gasan zone",
          "regionNo": "1"
        },
        "region": {
          "regionNo": "1",
          "regionCode": "KR",
          "regionName": "Korea"
        },
        "cloudDBConfigList": [],
        "cloudDBConfigGroupList": [],
        "accessControlGroupList": [
          {
            "accessControlGroupConfigurationNo": "23949",
            "accessControlGroupName": "cloud-db-ix15",
            "accessControlGroupDescription": "Group for cloud DB service 'test' (automatically created)",
            "isDefault": false,
            "createDate": "2018-12-28T14:37:29+0900"
          }
        ],
        "cloudDBServerInstanceList": [
          {
            "cloudDBServerInstanceNo": "882618",
            "cloudDBServerInstanceStatusName": "restarting",
            "cloudDBServerName": "test-001",
            "cloudDBServerRole": {
              "code": "M",
              "codeName": "Master"
            },
            "privateDnsName": "db-qttq.beta-cdb.ntruss.com",
            "publicDnsName": "",
            "dataStorageSize": 10737418240,
            "usedDataStorageSize": 0,
            "createDate": "2018-12-28T14:37:00+0900",
            "uptime": "2018-12-28T14:39:00+0900"
          },
          {
            "cloudDBServerName": "test-002",
            "cloudDBServerRole": {
              "code": "H",
              "codeName": "Hidden Master"
            }
          }
        ]
      }
    ]
  }
}

Error codes

If a Cloud DB API request is invalid or an error occurs while processing the request, the API returns an HTTP status code representing success or failure with a detailed message in JSON.

There are two types of error codes: “common error code” of the Cloud DB API and “API Gateway error code.”