createCloudMysqlInstance

Prev Next

Available in VPC

Create a Cloud DB for MySQL instance.

Commands

The command statement is as follows:

ncloud vmysql createCloudMysqlInstance [regionCode] [vpcNo] [cloudMysqlImageProductCode] [cloudMysqlProductCode] [dataStorageTypeCode] [isHa] [isMultiZone] [isStorageEncryption] [isBackup] [backupFileRetentionPeriod] [backupTime] [isAutomaticBackup] [cloudMysqlServiceName] [cloudMysqlServerNamePrefix] [cloudMysqlUserName] [cloudMysqlUserPassword] [hostIp] [cloudMysqlPort] [cloudMysqlDatabaseName] [subnetNo] [standbyMasterSubnetNo] [isPrivateSubDomain] [privateSubDomainPrefix] [engineVersionCode] [isDeleteProtection] [output]

Parameter

The following describes the parameters.

Parameter Type Required Description Restrictions
regionCode String N Region code where the Cloud DB for MySQL instance exists -
vpcNo String Y VPC number -
cloudMysqlImageProductCode String N Cloud DB for MySQL image product code -
cloudMysqlProductCode String N Cloud DB for MySQL product code
  • It can be obtained through productCode of the getCloudMysqlProductList action.
  • Default: The minimum specification is selected, where the minimum specification is based on 1. memory and 2. CPU.
 -
dataStorageTypeCode String N Data storage type code
  • The data storage type can't be changed after installation.
  • Options:
    • When the generationCode of cloudMysqlImageProductCode is G2: SSD | HDD
    • When the generationCode of cloudMysqlImageProductCode is G3: CB2
  • Default
    • When the generationCode of cloudMysqlImageProductCode is G2: SSD
    • When the generationCode of cloudMysqlImageProductCode is G3: CB2
 -
isHa Boolean N High availability status
  • Selecting high availability creates two servers, including a standby master server, and incurs additional fees.
  • If isHa is false, isMultiZone and standbyMasterSubnetNo parameters are not used.
  • Default: true
 -
isMultiZone Boolean N Multi-zone status
  • If the high availability status (isHa) is true, then you can select whether to use multi-zone.
    - Selecting multi-zone provides higher availability by creating master and standby master servers in different zones.
  • Required if high availability (isHa) is true
  • Default: false
 -
isStorageEncryption Boolean N Data storage encryption application status (to be applied later)
  • When encryption is applied, the DB data is encrypted and saved in the storage. You can't change the storage encryption settings after creating a Cloud DB for MySQL instance.
  • Encryption can be applied only if the high availability status (isHa) is true.
  • Default: false
 -
isBackup Boolean N Backup status
  • If the high availability status (isHa) is true, then the backup status (isBackup) is fixed as true.
  • Default: true
 -
backupFileRetentionPeriod Integer N Backup file retention period
  • Backups are only supported for the InnoDB engine. Backups of tables created with other engines are not supported.
  • Backups are performed every day, and the backup files are stored in a separate backup storage. Fees are charged for the space you use.
  • Default: 1 (1 day)
 -
backupTime String N Backup time
  • It sets the time the backup is performed. This field must be entered if the backup status (isBackup) is true and the automatic backup status (isAutomaticBackup) is false.
  • (Example) 01:15
 -
isAutomaticBackup Boolean N Automatic backup time status
  • Select whether to have the backup time set automatically. If the automatic backup status (isAutomaticBackup) is true, then backupTime can't be entered.
  • Default: true
 -
cloudMysqlServiceName String Y Cloud DB for MySQL service name Only English letters, numbers, hyphens (-), and Korean letters are allowed.
  • Min: 3
  • Max: 30
cloudMysqlServerNamePrefix String Y Cloud DB for MySQL server name prefix
  • It is created with random text added to avoid a duplicate host name.
 Only lowercase English letters, numbers, and hyphens (-) can be used for the name.
  • It must start with an English letter and end with an English letter or a number.
    • Min: 3
    • Max: 20
cloudMysqlUserName String Y MySQL User ID Only English letters, numbers, and special character (\ _ , -) can be used, and it must start with an English letter.
  • Min: 4
  • Max: 16
cloudMysqlUserPassword String Y MySQL user password It must have at least one English letter, one special character, and one number.
  • Certain special characters (` \ & + \ " ' /) and spaces can't be used.
    • Min: 8
    • Max: 20
hostIp String Y MySQL user host
  • (Example)
  • Allow access to all: %
  • Allow access to specific IPs: 1.1.1.1
  • Allow access to an IP range: 1.1.1.%
  • Allow CIDR: 1.1.1.0/24
 -
cloudMysqlPort Integer N TCP port number to access the Cloud DB for MySQL instance
  • Default: 3306
  • 3306
or
  • min: 10000
  • max: 20000
cloudMysqlDatabaseName String Y DB name to be created by default in the Cloud DB for MySQL instance Only English letters, numbers, and special character (\ _ , -) can be used, and it must start with an English letter.
  • Min: 1
  • Max: 30
subnetNo String Y Subnet number
  • Check through the getCloudMysqlTargetSubnetList action.
  • Public domains can only be subscribed on DB servers created in the public subnet.
  • Subnet migrations are not available after creating the Cloud DB for MySQL instance.
 -
standbyMasterSubnetNo String N Subnet number of the standby master server
  • If multi-zone status (isMultiZone) is false, it does not accept input. If multi-zone status (isMultiZone) is true, input is required.
  • standbyMasterSubnetNo must be different from the master server's subnet and zone, and must be the same public or private.
  • It can be obtained through the getCloudMysqlTargetSubnetList action.
 -
isPrivateSubDomain Boolean N Private sub domain usage
  • If the private sub domain usage status (isPrivateSubDomain) is true, then you can specify the private sub domain prefix.
 -
privateSubDomainPrefix String N Private sub domain prefix
  • A sub domain is added to the private domain.
  • It must be entered if the private sub domain usage status (isPrivateSubDomain) is true.
 Only lowercase English letters, numbers, and hyphens (-) can be used for the name.
  • It must start with an English letter and end with an English letter or a number.
    • Min: 3
    • Max: 15
engineVersionCode String N Engine version -
isDeleteProtection Boolean N Cluster termination protection status
  • If true, the cluster can't be terminated.
  • Default: false
 -
output String N Response result's format type
  • Options: xml | json
  • Default: json
 -

Response

Response data type

The response data types for command calls are as follows:

  • CloudMysqlInstanceList type
CloudMysqlInstanceList extends CommonResponse Description
private Integer totalRows; Total number of lists searched
private List<CloudMysqlInstance> cloudMysqlInstanceList = new ArrayList<>();
  • CloudMysqlInstance type
CloudMysqlInstance Description
private String cloudMysqlInstanceNo; Cloud DB for MySQL instance number
private String cloudMysqlServiceName; Cloud DB for MySQL service name
private String cloudMysqlInstanceStatusName; Cloud DB for MySQL instance status name
  • creating
  • deleted
  • deleting
  • pending
  • recovering
  • reinstalling
  • restarting
  • running
  • settingup
  • shuttingdown
  • stopped
  • upgrading
  • downgrading
private CommonCode cloudMysqlInstanceStatus; Cloud DB for MySQL instance status code
  • INIT (init)
  • CREAT (created)
  • DEL (deleted)
private CommonCode cloudMysqlInstanceOperation; Cloud DB for MySQL instance operation code
  • CREAT (create)
  • DEL (delete)
  • FO (failover)
  • NULL (no)
  • SETUP (setup)
  • UPGD (upgrade)
  • DWGD (downgrade)
  • BKP (backup)
private String cloudMysqlImageProductCode; Cloud DB for MySQL image product code
private String engineVersion; Cloud DB for MySQL engine version
private CommonCode license; Cloud DB for MySQL license
private Integer cloudMysqlPort; Cloud DB for MySQL port
private Boolean isHa; High availability status
private Boolean isMultiZone; Multi-zone status
private Boolean isBackup; Backup status
private Integer backupFileRetentionPeriod; Backup file retention period
private String backupTime; Backup time
private String generationCode; Server generation code
private Date createDate; Issuance date
private List<String> accessControlGroupNoList; ACG number list
private List<String> cloudMysqlConfigList; Cloud DB for MySQL config list
private List<CloudMysqlServerInstance> cloudMysqlServerInstanceList; Cloud DB for MySQL server instance list
  • CloudMysqlServerInstance type
CloudMysqlServerInstance Description
private String cloudMysqlServerInstanceNo; Cloud DB for MySQL server instance number
private String cloudMysqlServerName; Cloud DB for MySQL server name
private CommonCode cloudMysqlServerRole; Cloud DB for MySQL server role
private String cloudMysqlServerInstanceStatusName; Cloud DB for MySQL server instance status name
  • creating
  • deleted
  • deleting
  • downgrading
  • pending
  • recovering
  • reinstalling
  • restarting
  • running
  • settingup
  • shuttingdown
  • stopped
  • upgrading
  • downgrading
private CommonCode cloudMysqlServerInstanceStatus; Cloud DB for MySQL server instance status code
  • DEL (deleted)
  • PEND (pending)
  • RUN (running)
  • STOP (stopped)
  • FSTOP (failure stopped)
private CommonCode cloudMysqlServerInstanceOperation; Cloud DB for MySQL server instance operation code
  • NOOP (no operation)
  • CREAT (create)
  • START (start)
  • RSTRT (restart)
  • SETUP (setup)
  • STOP (stop)
  • FO (failover)
  • DEL (delete)
  • UPGD (upgrade)
  • DWGD (downgrade)
  • RISTL (server reinstall)
  • MIG (migration)
private String cloudMysqlProductCode; Cloud DB for MySQL product code
private String regionCode; Region code
private String zoneCode; Zone code
private String vpcNo; VPC number
private String subnetNo; Subnet number
private Boolean isPublicSubnet; Public subnet status
private String publicDomain; Public domain name
private String privateDomain; Private domain name
private String privateIp; Private IP
private CommonCode dataStorageType; Data storage type
private Boolean isStorageEncryption; Data storage encryption status
private Long dataStorageSize; Data storage size
private Long usedDataStorageSize; Size of data storage in use
private Integer cpuCount; Number of virtual CPUs
private Long memorySize; Memory size
private Date uptime; VM booting completion time
private Date createDate; Issuance date

Examples

It describes call and response examples.

Call examples

The following is a call example.

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

Response example

The response example is as follows:

When the response result format type (output) is JSON

{
  "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",
        "generationCode": "G2",
        "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"
          }
        ]
      }
    ]
  }
}

When the response result format type (output) is XML


<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>
            <generationCode>G2</generationCode>
            <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>