createCloudMysqlInstance
  • PDF

createCloudMysqlInstance

  • PDF

VPC 환경에서 이용 가능합니다.

개요

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

요청

요청 파라미터

파라미터명 필수 여부 타입 제약 사항 설명
regionCode No String 리전 코드
Cloud DB for MySQL 인스턴스가 생성될 리전(Region)을 결정
regionCode는 getRegionList 액션을 통해서 획득
Default: getRegionList 조회 결과의 첫 번째 리전 선택
vpcNo Yes String VPC 번호
Cloud DB for MySQL 인스턴스가 생성될 VPC를 결정
vpcNo는 getCloudMysqlTargetVpcList 액션을 통해서 획득
cloudMysqlImageProductCode No String Cloud Mysql 이미지 상품 코드
cloudMysqlImageProductCode는 getCloudMysqlImageProductList 액션의 productCode로 획득
입력하지 않을 경우 Default값으로 생성
cloudMysqlProductCode No String Cloud Mysql 상품 코드
생성할 Cloud DB for MySQL 인스턴스의 서버 스펙을 결정
cloudMysqlProductCode는 getCloudMysqlProductList 액션의 productCode로 획득
Default: 최소 사양으로 선택. 최소 사양의 기준은 1. 메모리 2. CPU
dataStorageTypeCode No String 데이터 스토리지 타입 코드
설치 이후에 데이터 스토리지 타입은 변경 불가
Options: SSD \ HDD
Default: SSD
isHa No Boolean 고가용성 여부
고가용성을 선택하면 Standby Master 서버를 포함한 2대의 서버로 생성되며 추가 요금이 발생
고가용성 여부(isHa)가 false이면 isMultiZone, standbyMasterSubnetNo 파라미터는 사용되지 않음
Default: true
isMultiZone Conditional Boolean 멀티존 여부
고가용성 여부(isHa)가 true일 경우, 멀티존 여부를 선택
멀티존을 선택하면 Master 서버와 Standby Master 서버를 서로 다른 Zone에 생성하여 더욱 높은 가용성을 제공
고가용성 여부(isHa)가 true일 경우 반드시 입력
Default: false
isStorageEncryption No Boolean 데이터 스토리지 암호화 적용 여부
암호화 적용 시 DB 데이터는 암호화 되어 스토리지에 저장. Cloud DB for MySQL 인스턴스 생성 이후에는 스토리지 암호화 설정 변경이 불가능
고가용성 여부(isHa)가 true인 경우에만 암호화 적용이 가능
Default: false
isBackup No Boolean 백업 여부
고가용성 여부(isHa)가 true일 경우 백업 여부(isBackup)는 true로 고정
Default: true
backupFileRetentionPeriod No Integer 백업 파일 보관 기간
백업은 InnoDB 엔진만 지원하며, 그 외 다른 엔진으로 생성된 테이블의 백업은 미지원. 백업은 매일 수행되며, 백업 파일은 별도의 백업 스토리지에 저장. 요금은 사용하는 공간만큼 과금
Default: 1(1일)
backupTime Conditional String 백업 시간
백업이 수행되는 시간을 설정. 백업 여부(isBackup)가 true이고, 자동 백업 여부(isAutomaticBackup)가 false이면 반드시 입력
예제
- 01:15
isAutomaticBackup No Boolean 백업 시간 자동 여부
자동으로 백업 시간을 설정할지에 대한 여부를 선택. 자동 백업 여부(isAutomaticBackup)가 true이면 backupTime 입력이 불가능
Default: true
cloudMysqlServiceName Yes String 영어, 숫자, -의 특수문자, 한글만 입력 가능 Cloud Mysql 서비스 이름
cloudMysqlServerNamePrefix Yes String 영문자(소문자), 숫자, 하이픈(-)으로만 구성
첫 글자는 영문자여야 하고 마지막 글자는 영문자 또는 숫자
Cloud Mysql 서버 이름
호스트명 중복 방지를 위해 임의의 text가 추가로 포함되어 생성
cloudMysqlUserName Yes String 영어, 숫자, _, -의 특수문자만 허용하며 영어로 시작 접근 유저명
DB 관리자 용도로 사용할 유저명을 입력
cloudMysqlUserPassword Yes String 8자 이상, 영어/특수문자/숫자 3개 항목에 대해 1자 이상 포함
` & + \ " ' / 스페이스는 패스워드로 사용 불가능
접근 패스워드
DB 관리자 용도로 사용할 유저의 패스워드를 입력
hostIp Yes String 전체 접속 허용: %
특정 IP 접속 허용: 1.1.1.1
IP 대역 접속 허용: 1.1.1.%
접근 호스트의 IP
접속하고자 하는 Client IP를 입력
cloudMysqlPort No Integer 3306
or
Min: 10000, Max: 20000
Cloud Mysql 포트
MySQL 접근을 위한 TCP 포트 번호를 입력
Default: 3306
cloudMysqlDatabaseName Yes String 영어, 숫자, _, -의 특수문자만 허용하며 영어로 시작 Cloud Mysql의 DB명
기본으로 생성할 DB명을 입력
subnetNo Yes String Subnet 번호
생성할 Cloud Mysql 인스턴스의 Subnet을 결정
subnetNo는 getCloudMysqlTargetSubnetList 액션을 통해서 획득
Public 도메인은 Public Subnet에 생성된 DB 서버에서만 이용 신청이 가능
Cloud DB for MySQL 인스턴스 생성 이후에 Subnet 이전은 불가능
standbyMasterSubnetNo Conditional String Standby Master 서버의 Subnet 번호
멀티존 여부(isMultiZone)가 false이면 입력 받지 않으며 멀티존 여부(isMultiZone)가 true이면 반드시 입력
standbyMasterSubnetNo는 Master 서버의 Subnet과 Zone이 달라야 하며 같은 Public이거나 Private이어야만 함
standbyMasterSubnetNo는 getCloudMysqlTargetSubnetList 액션을 통해서 획득
isPrivateSubDomain No Boolean Private Sub Domain 사용 여부
Private Sub Domain 사용 여부(isPrivateSubDomain)가 true일 경우, private sub domain prefix를 지정 가능
privateSubDomainPrefix Conditional String 최소 3글자 이상, 최대 15자 까지만 입력이 가능
영문자(소문자), 숫자, 하이픈(-)으로만 구성
그리고 첫글자는 영문자여야 하고 마지막 글자는 영문자 또는 숫자
Private Sub Domain Prefix
privateSubDomainPrefix로 입력한 값은 sub domain에 자동으로 포함
Private Sub Domain 사용 여부(isPrivateSubDomain)가 true면 반드시 입력
output No String 응답 결과의 포맷 타입
Options: xml \ json
Default : json

응답

응답 데이터 타입

  • CloudMysqlInstanceList 타입
CloudMysqlInstanceList extends CommonResponse
private Integer totalRows;
private List<CloudMysqlInstance> cloudMysqlInstanceList = new ArrayList<>();
CloudMysqlInstance
private String cloudMysqlInstanceNo;
private String cloudMysqlServiceName;
private String cloudMysqlInstanceStatusName;
private CommonCode cloudMysqlInstanceStatus;
private CommonCode cloudMysqlInstanceOperation;
private String cloudMysqlImageProductCode;
private String engineVersion;
private CommonCode license;
private Integer cloudMysqlPort;
private Boolean isHa;
private Boolean isMultiZone;
private Boolean isBackup;
private Integer backupFileRetentionPeriod;
private String backupTime;
private Date createDate;
private AccessControlGroupNoList accessControlGroupNoList;
private CloudMysqlConfigList cloudMysqlConfigList;
private List<CloudMysqlServerInstance> cloudMysqlServerInstanceList;
AccessControlGroupNoList
private List<String> accessControlGroupNoList = new ArrayList<>();
CloudMysqlConfigList
private List<String> cloudMysqlConfigList = new ArrayList<>();
CloudMysqlServerInstance
private String cloudMysqlServerInstanceNo;
private String cloudMysqlServerName;
private CommonCode cloudMysqlServerRole;
private String cloudMysqlServerInstanceStatusName;
private CommonCode cloudMysqlServerInstanceStatus;
private CommonCode cloudMysqlServerInstanceOperation;
private String cloudMysqlProductCode;
private String regionCode;
private String zoneCode;
private String vpcNo;
private String subnetNo;
private Boolean isPublicSubnet;
private String publicDomain;
private String privateDomain;
private CommonCode dataStorageType;
private Boolean isStorageEncryption;
private Long dataStorageSize;
private Long usedDataStorageSize;
private Integer cpuCount;
private Long memorySize;
private Date uptime;
private Date createDate;

예시

요청 예시

ncloud vmysql 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

응답 예시

{
  "createCloudMysqlInstanceResponse": {
    "requestId": "ae758cc2-006c-4df5-8ad2-aeef4ecfa8bf",
    "returnCode": "0",
    "returnMessage": "success",
    "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": 3306,
        "isHa": true,
        "isMultiZone": true,
        "isBackup": true,
        "backupFileRetentionPeriod": 10,
        "backupTime": "02:00",
        "createDate": "2021-05-27T18:00:00+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": "2021-05-27T18:00:00+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": "2021-05-27T18:00:00+0900"
          }
        ]
      }
    ]
  }
}

<createCloudMysqlInstanceResponse>
    <requestId>c04bfdd1-e27e-4006-9bc3-bc37840ce1dd</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.5732.B050</cloudMysqlImageProductCode>
            <engineVersion>MYSQL5.7.32</engineVersion>
            <license>
                <code>GPL</code>
                <codeName>General Public License</codeName>
            </license>
            <cloudMysqlPort>13306</cloudMysqlPort>
            <isHa>true</isHa>
            <isMultiZone>true</isMultiZone>
            <isBackup>true</isBackup>
            <createDate>2021-05-27T18:00:00+0900</createDate>
            <accessControlGroupNoList/>
            <cloudMysqlConfigList/>
            <cloudMysqlServerInstanceList>
                <cloudMysqlServerInstance>
                    <cloudMysqlServerName>test-****-001-e04</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>2021-05-27T18:00:00+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>2021-05-27T18:00:00+0900</createDate>
                </cloudMysqlServerInstance>
            </cloudMysqlServerInstanceList>
        </cloudMysqlInstance>
    </cloudMysqlInstanceList>
</createCloudMysqlInstanceResponse>

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