createCloudDBInstance
- 인쇄
- PDF
createCloudDBInstance
- 인쇄
- PDF
기사 요약
이 요약이 도움이 되었나요?
의견을 보내 주셔서 감사합니다.
Classic 환경
Cloud DB 인스턴스를 생성합니다.
요청
요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.
메서드 | URI |
---|---|
GET | /createCloudDBInstance |
요청 헤더
헤더에 대한 설명은 다음과 같습니다.
필드 | 설명 |
---|---|
x-ncp-apigw-timestamp | 1970년 1월 1일 00:00:00 협정 세계시(UTC)부터의 경과 시간을 밀리초로 나타내며, API Gateway 서버와 시간 차가 5분 이상 나는 경우 유효하지 않은 요청으로 간주 |
x-ncp-iam-access-key | 네이버 클라우드 플랫폼에서 발급받은 Access Key |
x-ncp-apigw-api-key | API Gateway에서 발급받은 API Key로 v2에서는 사용하지 않음 |
x-ncp-apigw-signature-v2 | Access Key와 매핑되는 Secret Key로 암호화한 서명 |
Content-Type | 요청 바디의 콘텐츠 타입을 application/json으로 지정 |
요청 바디
요청 바디에 대한 설명은 다음과 같습니다.
필드 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
cloudDBImageProductCode | String | Optional | Cloud DB 이미지 상품 코드
|
cloudDBProductCode | String | Optional | Cloud DB 상품 스펙 코드
|
dbKindCode | String | Required | 생성할 Cloud DB 종류
|
cloudDBConfigGroupNo | String | Optional | Config Group 번호
|
collation | String | Optional | 문자셋 문자 데이터 정렬, 비교하는 방식 선택
|
dataStorageTypeCode | String | Optional | 데이터 스토리지 유형
|
isHa | Boolean | Optional | 고가용성 여부
|
hostIp | String | Conditional | 호스트 IP 접속하려는 Client IP 입력 dbKindCode 가 MYSQL 이면 반드시 입력 |
cloudDBServerName | String | Conditional | Cloud DB 서버 이름
|
cloudDBServiceName | String | Required | Cloud DB에서 사용하려는 서비스 이름
|
cloudDBUserName | String | Conditional | 접근 사용자명
|
cloudDBUserPassword | String | Conditional | 접근 비밀번호
|
cloudDBBasicName | String | Conditional | 기본으로 생성할 데이터베이스 이름 입력
|
cloudDBPort | Integer | Optional | Cloud DB 포트 접근을 위한 TCP 포트 번호 입력
|
isBackup | Boolean | Optional | 백업 여부
|
backupFileRetentionPeriod | Integer | Optional | 백업 파일 보관 기간(일)
|
isAutomaticBackup | Boolean | Optional | 자동으로 백업 시간을 설정할지 여부
|
backupTime | String | Conditional | 백업 시작 시간(HHMM)
|
regionNo | String | Optional | 리전 번호
|
zoneNo | String | Required | 존 번호
|
responseFormatType | String | Optional | 응답 결과의 형식
|
요청 예시
요청 예시는 다음과 같습니다.
curl --location --request GET 'https://ncloud.apigw.ntruss.com/clouddb/v2/createCloudDBInstance?dbKindCode=MYSQL&dataStorageTypeCode=SSD&isHa=true&hostIp=%&cloudDBServerName=test&cloudDBServiceName=test&cloudDBUserName=test&cloudDBUserPassword=test123&cloudDBBasicName=test&cloudDBPort=3306&isBackup=true&backupFileRetentionPeriod=1&isAutomaticBackup=true®ionNo=9&zoneNo=90&responseFormatType=json' \
--header 'accept: application/json' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'x-ncp-iam-access-key: {Sub Account Access Key}' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
createCloudDBInstance로 MySQL 서버를 생성하는 예시입니다.
- 서버 스펙: 기본 최소 사양(2 vCPU, 4G mem)
- 데이터 스토리지 유형: SSD
- 고가용성 여부: true
- 데이터베이스 이름: testdb
- 사용자 이름: testuser
- 접근 웹 서버 IP: 1.1.1.1
- 리전: 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"
}
응답
응답 형식을 설명합니다.
응답 바디
응답 바디에 대한 설명은 다음과 같습니다.
필드 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
returnCode | Integer | - | 응답 코드 값 |
returnMessage | String | - | 응답 메시지 |
totalRows | Integer | - | 조회된 목록의 총 개수 |
cloudDBInstanceList[] | String | - | 생성된 Cloud DB 인스턴스 정보 |
응답 상태 코드
네이버 클라우드 플랫폼에서 공통으로 사용하는 응답 상태 코드에 대한 자세한 내용은 Ncloud API 응답 상태 코드와 API Gateway 응답 상태 코드를 참조해 주십시오.
응답 예시
응답 예시는 다음과 같습니다.
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"
}
}
]
}
]
}
}
이 문서가 도움이 되었습니까?