createCloudDBInstance
    • PDF

    createCloudDBInstance

    • PDF

    Article Summary

    개요

    CloudDB 인스턴스를 생성합니다.

    요청

    요청 헤더

    헤더명설명
    x-ncp-apigw-timestamp1970년 1월 1일 00:00:00 협정 세계시(UTC)부터의 경과 시간을 밀리초(Millisecond)로 나타내며 API Gateway 서버와 시간 차가 5분 이상 나는 경우 유효하지 않은 요청으로 간주
    x-ncp-apigw-timestamp:{Timestamp}
    x-ncp-apigw-api-keyAPIGW에서 발급받은 키 값, 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-v2Access Key ID 값과 Secret Key로 암호화한 서명
    x-ncp-apigw-signature-v2:{API Gateway Signature}
    Content-TypeRequest body content type을 application/json으로 지정
    Content-Type: application/json

    요청 바디

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

    필드명필수 여부타입제약 사항설명
    cloudDBImageProductCodeNoString- Cloud DB 이미지 상품 코드
    getCloudDBImageProductList API를 통해서 필요한 입력값 조회 가능
    cloudDBProductCodeNoStringdefault : 최소 사양으로 선택- Cloud DB 상품 스펙 코드
    getCloudDBProductList API를 통해서 필요한 입력값 조회 가능
    dbKindCodeYesStringMYSQL | MSSQL | REDIS- DB 유형 코드
    생성할 Cloud DB 종류 선택
    collationNoStringKorean_Wansung_CI_AS | SQL_Latin1_General_CP1_CI_AS- 문자셋
    문자 데이터 정렬, 비교하는 방식 선택
    dbKindCode가 MSSQL일 경우 설정 가능
    dataStorageTypeCodeNoStringHDD | SSD
    default: SSD
    - 데이터 스토리지 타입
    isHaNobooleandefault : true- 고가용성 여부
    고가용성 선택 시 2대의 서버가 생성되며 자동 장애 복구 지원
    hostIpConditionalString- 호스트 IP
    접속하고자하는 Client IP 입력
    dbKindCode가 MYSQL일 경우 반드시 입력
    cloudDBServerNameConditionalStringMYSQL Min 길이: 3, Max 길이: 25
    REDIS Min 길이: 3, Max 길이: 15
    - Cloud DB 서버 이름
    Cloud DB 서버의 이름 입력
    중복 사용이 불가하며 서버 이름에 3 자리 숫자가 자동으로 채번되어 생성됨
    dbKindCode가 MSSQL일 경우 입력 불가
    cloudDBServiceNameYesStringMYSQL Min 길이: 3, Max 길이: 30
    MSSQL, REDIS Min 길이: 3, Max 길이: 15
    - Cloud DB 서비스 이름
    Cloud DB에서 사용하고자하는 서비스 이름 입력
    cloudDBBasicNameConditionalStringMin 길이: 1, Max 길이: 30- Cloud DB기본 이름
    기본으로 생성할 DB 명 입력
    dbKindCode가 MYSQL일 경우 반드시 입력
    cloudDBUserNameConditionalString영어, 숫자, “_”문자만 허용,
    반드시 영어로 시작
    Min 길이: 4, Max 길이: 16
    - 접근 유저명
    dbKindCode가 MYSQL, MSSQL일 경우 반드시 입력
    cloudDBUserPasswordConditionalStringMin 길이: 8, Max 길이: 20- 접근 패스워드
    dbKindCode가 MYSQL, MSSQL일 경우 반드시 입력
    cloudDBPortNointegerMYSQL default: 3306,
    MSSQL default: 1433,
    REDIS default: 6379
    디폴트 값 or 10000~20000
    - Cloud DB 포트
    접근을 위한 TCP 포트 번호 입력
    cloudDBConfigGroupNoNoStringdefault : 0 (mssql_2016_default)- Config Group 번호
    getCloudDBConfigGroupList API를 이용해서 조회 가능
    dbKindCode가 MSSQL일 경우 설정 가능
    isBackupNobooldefault : true- 백업 여부
    dbKindCode가 MYSQL, REDIS일 경우에 설정 가능
    고가용성 여부(isHa)가 true 인 경우, true 로 고정됨
    backupFileRetentionPeriodNointegerdefault: 1 일
    Min: 1, Max: 30
    - 백업 파일 보관 기간
    백업 파일을 보관할 기간 입력
    isAutomaticBackupNobooldefault : true- 자동 백업 여부
    자동으로 백업시간을 설정할지에 대한 여부 선택
    backupTimeConditionalStringHHMM 형식. 15분 단위만 입력 가능- 백업 시간
    백업 시작 시간 입력
    isAutomaticBackup이 false일 경우 반드시 입력
    regionNoNoString- 리전 번호
    getRegionList API를 통해서 필요한 입력 값 조회 가능
    zoneNoYesString- Zone 번호
    getZoneList API를 통해서 필요한 입력 값 조회 가능
    responseFormatTypeNoStringXML | JSON
    default: XML
    - 응답 결과의 포맷 타입

    응답

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

    예시

    요청 예시

    curl
    -X GET "https://ncloud.apigw.ntruss.com/clouddb/v2/createCloudDBInstance?dbKindCode=MYSQL&dataStorageTypeCode=SSD&isHa=true&hostIp=%25&cloudDBServerName=test&cloudDBServiceName=test&cloudDBUserName=test&cloudDBUserPassword=test123&cloudDBBasicName=test&cloudDBPort=3306&isBackup=true&backupFileRetentionPeriod=1&isAutomaticBackup=true&regionNo=9&zoneNo=90&responseFormatType=json"
    -H "accept: application/json"
    -H "Content-Type: application/x-www-form-urlencoded"
    -H "x-ncp-iam-access-key: Y0Z9EG0lKoeWAQCSHRtM"
    -H "x-ncp-apigw-timestamp: 1545634234391"
    -H "x-ncp-apigw-signature-v2: B7hM8hQ9DtitHxPFwimCG2Dir7MPLjRRVOkRRaxhYaE="
    
    https://ncloud.apigw.ntruss.com/clouddb/v2/createCloudDBInstance?dbKindCode=MYSQL&dataStorageTypeCode=SSD&isHa=true&hostIp=%25&cloudDBServerName=test&cloudDBServiceName=test&cloudDBUserName=test&cloudDBUserPassword=test123&cloudDBBasicName=test&cloudDBPort=3306&isBackup=true&backupFileRetentionPeriod=1&isAutomaticBackup=true&regionNo=9&zoneNo=90&responseFormatType=json
    

    요청 샘플

    • MySQL 서버 생성
      • 서버스펙 : default 최소사양 (2vCPU, 4G mem)
      • 데이터스토리지 : SSD
      • 고가용성 : true
      • DB명 : testdb
      • User명 : testuser
      • 접근 웹서버 IP : 1.1.1.1
      • region : KR-1
    {
      "dbKindCode": "MYSQL",
      "dataStorageTypeCode": "SSD",
      "isHa": true,
      "hostIp": "1.1.1.1",
      "cloudDBServerName": "test",
      "cloudDBServiceName": "test",
      "cloudDBUserName": "testuser",
      "cloudDBUserPassword": "test123",
      "cloudDBBasicName": "testdb",
      "cloudDBPort": 3306,
      "isBackup": true,
      "backupFileRetentionPeriod": 1,
      "isAutomaticBackup": true,
      "regionNo": "1",
      "zoneNo": "2",
      "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
    
    {
      "createCloudDBInstanceResponse": {
        "returnCode": "0",
        "returnMessage": "success",
        "totalRows": 1,
        "cloudDBInstanceList": [
          {
            "cloudDBInstanceNo": "881713",
            "cloudDBServiceName": "test",
            "dbKindCode": "MYSQL",
            "engineVersion": "MYSQL5.7.19",
            "cpuCount": 2,
            "dataStorageType": {
              "code": "SSD",
              "codeName": "SSD"
            },
            "licenseCode": "GPL",
            "cloudDBPort": 3306,
            "isHa": true,
            "cloudDBInstanceStatusName": "creating",
            "collation": "",
            "createDate": "2018-12-24T17:59:00+0900",
            "cloudDBImageProductCode": "SPSWMYSQLLINUX01",
            "cloudDBProductCode": "SPSVRDBAAS000001",
            "isCloudDBConfigNeedReboot": false,
            "isCloudDBNeedReboot": false,
            "cloudDBConfigList": [],
            "cloudDBConfigGroupList": [],
            "accessControlGroupList": [],
            "cloudDBServerInstanceList": [
              {
                "cloudDBServerInstanceNo": "",
                "cloudDBServerInstanceStatusName": "pending",
                "cloudDBServerName": "test-001",
                "cloudDBServerRole": {
                  "code": "M",
                  "codeName": "Master"
                },
                "privateDnsName": "",
                "publicDnsName": "",
                "dataStorageSize": 10737418240,
                "usedDataStorageSize": 0,
                "createDate": "2018-12-24T17:59:00+0900"
              },
              {
                "cloudDBServerName": "test-002",
                "cloudDBServerRole": {
                  "code": "H",
                  "codeName": "Hidden Master"
                }
              }
            ]
          }
        ]
      }
    }
    

    오류 코드

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

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

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

    이 문서가 도움이 되었습니까?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.