rebootCloudDBServerInstance

개요

CloudDB 인스턴스를 재시작합니다.

요청

요청 헤더

헤더명 설명
x-ncp-apigw-timestamp 1970년 1월 1일 00:00:00 협정 세계시(UTC)부터의 경과 시간을 밀리초(Millisecond)로 나타내며 API Gateway 서버와 시간 차가 5분 이상 나는 경우 유효하지 않은 요청으로 간주
x-ncp-apigw-timestamp:{Timestamp}
x-ncp-apigw-api-key APIGW에서 발급받은 키 값, v2를 사용할 경우 api-key는 사용하지 않습니다.
x-ncp-apigw-api-key:{API Gateway API Key}
x-ncp-iam-access-key 네이버 클라우드 플랫폼 포털에서 발급받은 Access Key ID 값
x-ncp-iam-access-key:{Sub Account Access Key}
x-ncp-apigw-signature-v2 Access Key ID 값과 Secret Key로 암호화한 서명
x-ncp-apigw-signature-v2:{API Gateway Signature}
Content-Type Request body content type을 application/json으로 지정
Content-Type: application/json

요청 바디

API 요청 시 필드명의 대소문자 구분이 필요합니다

파라미터명 필수 여부 타입 제약 사항 설명
cloudDBServerInstanceNo Y string CloudDb 인스턴스 번호
isWithFailover N TRUE failover 여부
isRebootNow N TRUE 지금 재부팅 여부
rebootTime N string 재부팅 예약 시간
responseFormatType N string response의 결과 format 설정
  • cloudDBServerInstanceNo
    • 재시작하고자하는 Cloud DB 서버의 Instance번호입니다.
  • isWithFailover
    • 재시작 시, Fail-over를 수행할지 여부를 지정합니다.
  • isRebootNow
    • 즉시 재시작을 수행합니다.
  • rebootTime
    • 재시작을 원하는 시간을 입력합니다.
  • responseFormatType
    • API 실행 결과를 응답받을 format을 정합니다. xml과 json 중에서 선택 가능합니다.

응답

필드명 타입 설명 비고
returnCode Integer 응답 코드 값
returnMessage String 응답 메시지
totalRows Integer 응답 결과 row 수
cloudDBInstanceList[] String 생성된 cloud DB Instance 정보

예시

요청 예시

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

요청 샘플

  • 인스턴스 번호를 확인 후 해당 서버 재시작
{
  "cloudDBServerInstanceNo": "882618",
  "isRebootNow": true,
  "responseFormatType": "json"
}

응답 예시

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": "가산 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"
            }
          }
        ]
      }
    ]
  }
}

오류 코드

Cloud DB API 요청이 잘못되었거나, 처리 도중 오류가 발생하면 HTTP 상태코드로 성공/실패를 반환하고 JSON 형식으로 상세 메시지를 반환합니다

오류 코드는 Cloud DB API의 ‘공통 오류 코드’와 ‘API Gateway 오류 코드’ 두 가지입니다

오류 코드 응답 메시지 설명
200 Ok
500 Server Error