createCloudMysqlInstance

Prev Next

Cloud DB for MySQL 인스턴스를 생성합니다.

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

메서드 URI
GET, POST /createCloudMysqlInstance

Cloud DB for MySQL API에서 공통으로 사용하는 헤더에 대한 자세한 내용은 Cloud DB for MySQL 요청 헤더를 참조해 주십시오.

파라미터에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
regionCode String Optional 리전 코드
  • 생성할 Cloud DB for MySQL 인스턴스의 리전 코드
  • getRegionList를 통해 확인
  • getRegionList 조회 결과의 첫 번째 리전(기본값)
vpcNo String Required Cloud DB for MySQL 인스턴스를 생성할 VPC 번호
cloudMysqlImageProductCode String Optional Cloud DB for MySQL 이미지 상품 코드
cloudMysqlProductCode String Optional Cloud DB for MySQL 상품 코드
  • 생성할 Cloud DB for MySQL 인스턴스의 서버 스펙을 결정
  • getCloudMysqlProductList를 통해 확인
  • 최소 사양(기본값)
  • 최소 사양의 기준: 1. 메모리 2. CPU 순서로 결정
dataStorageTypeCode String Optional 데이터 스토리지 타입 코드
  • 설치 이후 데이터 스토리지 타입 변경 불가
  • SSD | HDD | CB1
  • cloudMysqlImageProductCode의 generationCode에 따라 기본값 상이함
    • G2인 경우: SSD
    • G3인 경우: CB1
isHa Boolean Optional 고가용성 여부
  • true (기본값) | false
  • true(고가용성 선택)인 경우 Standby Master 서버를 포함한 2대의 서버로 생성되며 추가 요금 발생
  • false인 경우 isMultiZone, standbyMasterSubnetNo 파라미터는 사용되지 않음
isMultiZone Boolean Conditional Multi Zone 여부
  • true | false (기본값)
  • 고가용성 여부(isHa)가 true일 경우 필수 입력
  • true인 경우 Master 서버와 Standby Master 서버를 서로 다른 존에 생성하여 더욱 높은 가용성을 제공
isStorageEncryption Boolean Optional 데이터 스토리지 암호화 적용 여부 (추후 적용)
  • true | false (기본값)
  • 고가용성 여부(isHa)가 true인 경우에만 암호화 적용 가능
  • 암호화 적용 시, DB 데이터는 암호화되어 스토리지에 저장
  • Cloud DB for MySQL 인스턴스 생성 이후 스토리지 암호화 설정 변경 불가
isBackup Boolean Optional MySQL의 백업 설정 여부
  • true (기본값) | false
  • 고가용성 여부(isHa)가 true일 경우 백업 여부(isBackup)는 true로 고정됨
backupFileRetentionPeriod Integer Optional 백업 파일 보관 기간 (일)
  • 1 (기본값)
  • InnoDB 엔진으로 생성된 테이블만 백업 지원
  • 백업은 매일 수행되며, 백업 파일은 별도의 스토리지에 저장
backupTime String Conditional 백업 시점 설정
  • true (기본값) | false
  • 백업 여부(isBackup)가 true, 자동 백업 여부(isAutomaticBackup)가 false인 경우 필수 입력
  • <예시>01:15 (선택한 시간 + 15분 사이에 Backup이 시작)
isAutomaticBackup Boolean Optional 백업 시점 자동 설정 여부
  • true (기본값) | false
  • 설정 값이 true인 경우, backupTime 입력 불가
cloudMysqlServiceName String Required 생성할 Cloud DB for MySQL 서비스 이름
  • 3~30자로 영문자, 숫자, 한글, 특수 문자 '-'만 입력 가능
cloudMysqlServerNamePrefix String Required 생성할 Cloud DB for MySQL 서버 이름 접두사
  • 3~20자로 영문자, 숫자, 특수 문자 '-'를 허용하며 영문자로 시작해서 영문자 또는 숫자로 끝나야 함
  • 접두사 뒤에 3자리 숫자가 자동으로 만들어지고, 호스트명 중복 방지를 위해 임의의 텍스트가 추가로 포함되어 생성됨
  • <예시> 접두사가 test-123인 경우: test-123-001-4y1v
cloudMysqlUserName String Required DB User 계정 아이디
  • 4~16자로 영문자, 숫자, 특수 문자 '-', '_'를 허용하며 영문자로 시작해야 함
  • 미리 정의된 예약어 사용 불가능
cloudMysqlUserPassword String Required DB User 계정 패스워드
  • 8~20자로 영문, 숫자, 특수문자를 각 1자 이상씩 포함하여 조합
  • 특수문자 ` & + \ " ' / 및 공백 사용 불가
  • Password plugin이 활성화된 상태에서는 plugin으로 설정한 정책도 만족해야 함
hostIp String Required MySQL Server에 접근할 IP 주소
  • 전체 접속 허용: %
  • 특정 IP 접속 허용: <예시> 1.1.1.1
  • IP 대역 접속 허용: <예시> 1.1.1.%
  • CIDR 허용: <예시> 1.1.1.0/24
  • GET 메서드 사용 시 %는 %25로 URL 인코딩 필요
cloudMysqlPort Integer Optional Cloud DB for MySQL 인스턴스에 접근하기 위한 TCP 포트 번호
  • 3306 (기본값)
  • 지정 범위: 10000~20000
  • 한 번 지정한 포트 번호는 변경 불가
cloudMysqlDatabaseName String Required Cloud DB for MySQL 인스턴스에 기본으로 생성할 DB 이름
  • 1~30자로 영문자, 숫자, 특수 문자 '\ _ , -'를 허용하며 영문자로 시작해야 함
subnetNo String Required Cloud DB for MySQL 인스턴스에서 사용할 기본 네트워크 인터페이스의 Subnet 번호
  • getCloudMysqlTargetSubnetList를 통해 확인
  • Public 도메인은 Public Subnet에 생성된 DB 서버에서만 이용 신청 가능
  • Cloud DB for MySQL 인스턴스 생성 이후 Subnet 이전 불가
standbyMasterSubnetNo String Conditional Standby Master 서버의 Subnet 번호
  • Multi Zone인 Cloud DB for MySQL인 경우 필수 입력
  • Master 서버의 Subnet과 Zone이 다르고, Public 또는 Private는 같아야 함
  • getCloudMysqlTargetSubnetList를 통해 확인
isPrivateSubDomain Boolean Optional Private Sub 도메인 사용 여부
  • true | false
  • 설정 값이 true일 경우, privateSubDomainPrefix 지정 가능
privateSubDomainPrefix String Conditional Private 도메인에 추가할 Sub 도메인 입력
  • 3~15자로 영문자, 숫자, 특수 문자 '-'를 허용하며 영문자로 시작해서 영문자 또는 숫자로 끝나야 함
  • Private Sub 도메인 사용 여부(isPrivateSubDomain)가 true인 경우 필수
  • Slave 추가, Recovery 추가 시에도 동일한 Sub 도메인 정책이 추가됨
engineVersionCode String Conditional DB 엔진 버전
isDeleteProtection Boolean Optional 클러스터 반납 보호 여부
  • true | false(기본값)
    • true: 클러스터 반납 불가
    • false: 클러스터 반납 가능
responseFormatType String Optional 응답 결과의 형식
  • xml (기본값) | json

요청 예시는 다음과 같습니다.

curl --location --request GET 'https://fin-ncloud.apigw.fin-ntruss.com/vmysql/v2/createCloudMysqlInstance
?regionCode=KR
&vpcNo=****83
&cloudMysqlImageProductCode=SW.VDBAS.DBAAS.LNX64.CNTOS.0708.MYSQL.8025.B050
&cloudMysqlProductCode=SVR.VDBAS.STAND.C002.M008.NET.HDD.B050.G002
&dataStorageTypeCode=SSD
&isHa=true
&isMultiZone=true
&isStorageEncryption=true
&isBackup=true
&backupFileRetentionPeriod=10
&backupTime=02:00
&isAutomaticBackup=false
&cloudMysqlServiceName=test-****
&cloudMysqlServerNamePrefix=test-****
&cloudMysqlUserName=test-****
&cloudMysqlUserPassword=********
&hostIp=192.168.0.%
&cloudMysqlPort=13306
&cloudMysqlDatabaseName=test-****
&subnetNo=****91
&standbyMasterSubnetNo=****93'
--header 'x-ncp-apigw-timestamp: {Timestamp}' 
--header 'x-ncp-iam-access-key: {Access Key}' 
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
Curl

응답 형식을 설명합니다.

응답 바디는 CloudMysqlInstanceList를 참조해 주십시오.

네이버 클라우드 플랫폼에서 공통으로 사용하는 응답 상태 코드에 대한 자세한 내용은 Ncloud API 응답 상태 코드를 참조해 주십시오.

응답 예시는 다음과 같습니다.

  • responseFormatType=json 일 때
{
    "createCloudMysqlInstanceResponse": {
        "totalRows": 1,
        "cloudMysqlInstanceList": [
            {
                "cloudMysqlInstanceNo": "****890",
                "cloudMysqlServiceName": "test-****",
                "cloudMysqlInstanceStatusName": "creating",
                "cloudMysqlInstanceStatus": {
                    "code": "INIT",
                    "codeName": "CLOUD DATABASE(VPC) Init State"
                },
                "cloudMysqlInstanceOperation": {
                    "code": "CREAT",
                    "codeName": "CLOUD DATABASE(VPC) Creat OP"
                },
                "cloudMysqlImageProductCode": "SW.VDBAS.DBAAS.LNX64.CNTOS.0708.MYSQL.8025.B050",
                "engineVersion": "MYSQL8.0.25",
                "license": {
                    "code": "GPL",
                    "codeName": "General Public License"
                },
                "cloudMysqlPort": 13306,
                "isHa": true,
                "isMultiZone": true,
                "isBackup": true,
                "backupFileRetentionPeriod": 10,
                "backupTime": "02:00",
                "generationCode": "G2",
                "createDate": "2024-05-23T11:25:09+0900",
                "accessControlGroupNoList": [],
                "cloudMysqlConfigList": [],
                "cloudMysqlServerInstanceList": [
                    {
                        "cloudMysqlServerName": "test-****-001-e04",
                        "cloudMysqlServerRole": {
                            "code": "M",
                            "codeName": "Master"
                        },
                        "cloudMysqlServerInstanceStatusName": "creating",
                        "cloudMysqlServerInstanceStatus": {
                            "code": "PEND",
                            "codeName": "CLOUD DATABASE(VPC) Server Pending State"
                        },
                        "cloudMysqlServerInstanceOperation": {
                            "code": "CREAT",
                            "codeName": "CLOUD DATABASE(VPC) Server Create OP"
                        },
                        "cloudMysqlProductCode": "SVR.VDBAS.STAND.C002.M008.NET.HDD.B050.G002",
                        "regionCode": "KR",
                        "zoneCode": "KR-1",
                        "vpcNo": "****83",
                        "subnetNo": "****91",
                        "isPublicSubnet": true,
                        "dataStorageType": {
                            "code": "SSD",
                            "codeName": "SSD"
                        },
                        "isStorageEncryption": true,
                        "dataStorageSize": 10737418240,
                        "cpuCount": 2,
                        "memorySize": 8589934592,
                        "createDate": "2024-05-23T11:25:09+0900"
                    },
                    {
                        "cloudMysqlServerName": "test-****-002-e05",
                        "cloudMysqlServerRole": {
                            "code": "H",
                            "codeName": "Standby Master"
                        },
                        "cloudMysqlServerInstanceStatusName": "creating",
                        "cloudMysqlServerInstanceStatus": {
                            "code": "PEND",
                            "codeName": "CLOUD DATABASE(VPC) Server Pending State"
                        },
                        "cloudMysqlServerInstanceOperation": {
                            "code": "CREAT",
                            "codeName": "CLOUD DATABASE(VPC) Server Create OP"
                        },
                        "cloudMysqlProductCode": "SVR.VDBAS.STAND.C002.M008.NET.HDD.B050.G002",
                        "regionCode": "KR",
                        "zoneCode": "KR-2",
                        "vpcNo": "****83",
                        "subnetNo": "****93",
                        "isPublicSubnet": true,
                        "dataStorageType": {
                            "code": "SSD",
                            "codeName": "SSD"
                        },
                        "isStorageEncryption": true,
                        "dataStorageSize": 10737418240,
                        "cpuCount": 2,
                        "memorySize": 8589934592,
                        "createDate": "2024-05-23T11:25:09+0900"
                    }
                ]
            }
        ],
        "requestId": "a3d093cf-****-****-****-394da22ea7f8",
        "returnCode": "0",
        "returnMessage": "success"
    }
}
JSON
  • responseFormatType=xml (기본값) 일 때
<?xml version="1.0" encoding="UTF-8"?>
<createCloudMysqlInstanceResponse>
  <requestId>a3d093cf-****-****-****-394da22ea7f8</requestId>
  <returnCode>0</returnCode>
  <returnMessage>success</returnMessage>
  <totalRows>1</totalRows>
  <cloudMysqlInstanceList>
    <cloudMysqlInstance>
      <cloudMysqlInstanceNo>****890</cloudMysqlInstanceNo>
      <cloudMysqlServiceName>test-****</cloudMysqlServiceName>
      <cloudMysqlInstanceStatusName>creating</cloudMysqlInstanceStatusName>
      <cloudMysqlInstanceStatus>
        <code>INIT</code>
        <codeName>CLOUD DATABASE(VPC) Init State</codeName>
      </cloudMysqlInstanceStatus>
      <cloudMysqlInstanceOperation>
        <code>CREAT</code>
        <codeName>CLOUD DATABASE(VPC) Creat OP</codeName>
      </cloudMysqlInstanceOperation>
      <cloudMysqlImageProductCode>SW.VDBAS.DBAAS.LNX64.CNTOS.0708.MYSQL.8025.B050</cloudMysqlImageProductCode>
      <engineVersion>MYSQL8.0.25</engineVersion>
      <license>
        <code>GPL</code>
        <codeName>General Public License</codeName>
      </license>
      <cloudMysqlPort>13306</cloudMysqlPort>
      <isHa>true</isHa>
      <isMultiZone>true</isMultiZone>
      <isBackup>true</isBackup>
      <backupFileRetentionPeriod>10</backupFileRetentionPeriod>
      <backupTime>02:00</backupTime>
      <generationCode>G2</generationCode>
      <createDate>2024-05-23T11:25:09+0900</createDate>
      <accessControlGroupNoList />
      <cloudMysqlConfigList />
      <cloudMysqlServerInstanceList>
        <cloudMysqlServerInstance>
          <cloudMysqlServerName>test-****-001-4y1v</cloudMysqlServerName>
          <cloudMysqlServerRole>
            <code>M</code>
            <codeName>Master</codeName>
          </cloudMysqlServerRole>
          <cloudMysqlServerInstanceStatusName>creating</cloudMysqlServerInstanceStatusName>
          <cloudMysqlServerInstanceStatus>
            <code>PEND</code>
            <codeName>CLOUD DATABASE(VPC) Server Pending State</codeName>
          </cloudMysqlServerInstanceStatus>
          <cloudMysqlServerInstanceOperation>
            <code>CREAT</code>
            <codeName>CLOUD DATABASE(VPC) Server Create OP</codeName>
          </cloudMysqlServerInstanceOperation>
          <cloudMysqlProductCode>SVR.VDBAS.STAND.C002.M008.NET.HDD.B050.G002</cloudMysqlProductCode>
          <regionCode>KR</regionCode>
          <zoneCode>KR-1</zoneCode>
          <vpcNo>****83</vpcNo>
          <subnetNo>****91</subnetNo>
          <isPublicSubnet>true</isPublicSubnet>
          <dataStorageType>
            <code>SSD</code>
            <codeName>SSD</codeName>
          </dataStorageType>
          <isStorageEncryption>true</isStorageEncryption>
          <dataStorageSize>10737418240</dataStorageSize>
          <cpuCount>2</cpuCount>
          <memorySize>8589934592</memorySize>
          <createDate>2024-05-23T11:25:09+0900</createDate>
        </cloudMysqlServerInstance>
        <cloudMysqlServerInstance>
          <cloudMysqlServerName>test-****-002-e05</cloudMysqlServerName>
          <cloudMysqlServerRole>
            <code>H</code>
            <codeName>Standby Master</codeName>
          </cloudMysqlServerRole>
          <cloudMysqlServerInstanceStatusName>creating</cloudMysqlServerInstanceStatusName>
          <cloudMysqlServerInstanceStatus>
            <code>PEND</code>
            <codeName>CLOUD DATABASE(VPC) Server Pending State</codeName>
          </cloudMysqlServerInstanceStatus>
          <cloudMysqlServerInstanceOperation>
            <code>CREAT</code>
            <codeName>CLOUD DATABASE(VPC) Server Create OP</codeName>
          </cloudMysqlServerInstanceOperation>
          <cloudMysqlProductCode>SVR.VDBAS.STAND.C002.M008.NET.HDD.B050.G002</cloudMysqlProductCode>
          <regionCode>KR</regionCode>
          <zoneCode>KR-2</zoneCode>
          <vpcNo>****83</vpcNo>
          <subnetNo>****93</subnetNo>
          <isPublicSubnet>true</isPublicSubnet>
          <dataStorageType>
            <code>SSD</code>
            <codeName>SSD</codeName>
          </dataStorageType>
          <isStorageEncryption>true</isStorageEncryption>
          <dataStorageSize>10737418240</dataStorageSize>
          <cpuCount>2</cpuCount>
          <memorySize>8589934592</memorySize>
          <createDate>2024-05-23T11:25:09+0900</createDate>
        </cloudMysqlServerInstance>
      </cloudMysqlServerInstanceList>
    </cloudMysqlInstance>
  </cloudMysqlInstanceList>
</createCloudMysqlInstanceResponse>
XML