createCloudMssqlInstance

Prev Next

Available in VPC

Create a Cloud DB for MSSQL instance.

Commands

The command statement is as follows:

ncloud vmssql createCloudMssqlInstance [regionCode] [vpcNo] [subnetNo] [mirrorSubnetNo] [cloudMssqlServiceName] [configGroupNo] [cloudMssqlImageProductCode] [cloudMssqlProductCode] [dataStorageTypeCode] [isHa] [isMultiZone] [backupFileRetentionPeriod] [backupTime] [isAutomaticBackup] [cloudMssqlUserName] [cloudMssqlUserPassword] [cloudMssqlPort] [characterSetName] [engineVersionCode] [output]

Parameter

The following describes the parameters.

Parameter Type Required Description Restrictions
regionCode String N Region code
  • regionCode can be obtained through the getRegionList action.
  • Default: Select the first Region of the getRegionList query result.
 -
vpcNo String Y VPC number -
subnetNo String Y Subnet number
  • subnetNo can be obtained through the getCloudMssqlTargetSubnetList 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 MSSQL instance.
 -
mirrorSubnetNo String N Subnet number of the mirror server
  • If multi-zone status (isMultiZone) is false, it does not accept input. If multi-zone status (isMultiZone) is true, input is required.
  • mirrorSubnetNo must be in a different zone from the principal server's subnet, and must be the same public or private.
  • mirrorSubnetNo can be obtained through the getCloudMssqlTargetSubnetList action.
 -
cloudMssqlServiceName String Y Cloud DB for MSSQL service name
  • Only English letters, numbers, hyphens (-), and Korean letters are allowed.
  • Min: 3
  • Max: 15
configGroupNo String N Cloud DB for MSSQL config group number
  • A config group created in advance can be applied when you create a server.
  • If you don't have your own config group, you can choose from the config groups provided by default.
  • Check through getCloudMssqlConfigGroupList
  • Default: 0
 -
cloudMssqlImageProductCode String N Cloud DB for MSSQL image product code
  • cloudMssqlImageProductCode can be obtained through productCode of the getCloudMssqlImageProductList action.
  • It is created with the default value if not entered.
 -
cloudMssqlProductCode String N Cloud DB for MSSQL product code
  • Determine the sever specifications of the Cloud DB for MSSQL instance to create
  • cloudMssqlProductCode can be obtained through productCode of the getCloudMssqlProductList 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 cloudMssqlImageProductCode is G2: SSD | HDD
    • When the generationCode of cloudMssqlImageProductCode is G3: CB2
  • Default
    • When the generationCode of cloudMssqlImageProductCode is G2: SSD
    • When the generationCode of cloudMssqlImageProductCode is G3: CB2
 -
isHa Boolean Y High availability status
  • Selecting high availability creates two servers, including a standby master server, and incurs additional fees.
  • Default: true
 -
isMultiZone Boolean N Multi-zone status
  • If is high availability status (isHa) is true, select whether to be multi-zoned.
  • Selecting multi-zone provides higher availability by creating principal and mirror master servers in different zones.
  • Required if high availability (isHa) is true
  • Default: false
 -
backupFileRetentionPeriod Integer N Backup file retention period
  • Backup is performed every day, and the backup file is stored in a separate backup storage.
  • Fees are charged for the space you use.
  • Default: 1 (1 day)
  • Min: 1
  • Max: 30
backupTime String N Backup time
  • It sets the time the backup is performed. This field must be entered if the automatic backup status (isAutomaticBackup) is false.
  • 01:15
  • HHMM format. You can only enter in increments of 15 minutes.
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 it is set automatically, ignoring backupTime even if it is entered.
 -
cloudMssqlUserName String Y Access user name
  • Rnter the username to use as the DB admin.
  • Only English letters, numbers, and underscores (_) can be used, and it must start with an English letter.
  • Min: 4
  • Max: 16
cloudMssqlUserPassword String Y Access password
  • Enter the user's password to be used for the DB admin
  • It must have at least one English letter, one special character, and one number.
  • ` & + \ " ' / and spaces can't be used in passwords.
  • Min: 8
  • Max: 20
cloudMssqlPort Integer N Cloud DB for MSSQL port
  • Enter the TCP port number for MSSQL access.
  • Default: 1433
 1433
  • Min: 10000
  • Max: 20000
characterSetName String N DB character set -
engineVersionCode String N DB engine version -
output String N Response result's format type
  • Options: xml | json
  • Default: json
 -

Response

Response data type

  • CloudMssqlInstanceList type

    CloudMssqlInstanceList extends CommonResponse Description
    private Integer totalRows;
    private List<CloudMssqlInstance> cloudMssqlInstanceList = new ArrayList<>();

  • CloudMssqlInstance type

    CloudMssqlInstance Description
    private String cloudMssqlInstanceNo;
    private String cloudMssqlServiceName;
    private String cloudMssqlInstanceStatusName;
    private CommonCode cloudMssqlInstanceStatus;
    private CommonCode cloudMssqlInstanceOperation;
    private String generationCode;
    private String cloudMssqlImageProductCode;
    private Boolean isHa;
    private Boolean isMultiZone;
    private CommonCode license;
    private Integer cloudMssqlPort;
    private Integer backupFileRetentionPeriod;
    private String backupTime;
    private String configGroupNo;
    private String configGroupName;
    private String engineVersion;
    private Date createDate;
    private String dbCollation;
    private List<CloudMssqlServerInstance> cloudMssqlServerInstanceList;
    private AccessControlGroupNoList accessControlGroupNoList;

  • CloudMssqlServerInstance type

    CloudMssqlServerInstance Description
    private String cloudMssqlServerInstanceNo;
    private String cloudMssqlServerName;
    private CommonCode cloudMssqlServerRole;
    private String cloudMssqlServerInstanceStatusName;
    private CommonCode cloudMssqlServerInstanceStatus;
    private CommonCode cloudMssqlServerInstanceOperation;
    private String regionCode;
    private String zoneCode;
    private String vpcNo;
    private String subnetNo;
    private Long dataStorageSize;
    private Integer cpuCount;
    private Long memorySize;
    private Boolean isPublicSubnet;
    private String cloudMssqlProductCode;
    private String privateDomain;
    private String publicDomain;
    private Date createDate;
    private Date uptime;
    private CommonCode dataStorageType;
    private Long usedDataStorageSize;

  • AccessControlGroupNoList type

    AccessControlGroupNoList Description
    private List<String> accessControlGroupNoList = new ArrayList<>();

Examples

It describes call and response examples.

Call examples

The following is a call example.

ncloud vmssql createCloudMssqlInstance --regionCode KR --vpcNo ****83 --subnetNo ****91 --mirrorSubnetNo ****92 --cloudMssqlServiceName test-**** --configGroupNo **9 --cloudMssqlImageProductCode SW.VMSSL.OS.WND64.WINNT.SVR2016.MSSQL.15020005.SE.B100 --cloudMssqlProductCode SVR.VMSSL.STAND.C002.M008.NET.HDD.B100.G002 --dataStorageTypeCode SSD --isHa true --isMultiZone true --backupFileRetentionPeriod 10 --backupTime 00:15 --isAutomaticBackup true --cloudMssqlUserName test**** --cloudMssqlUserPassword ******** --cloudMssqlPort 1433 --characterSetName Korean_Wansung_CI_AS --engineVersionCode 15.0.4355.3

Response example

The response example is as follows:

When response result format type (output) is JSON

The following is an example when the response result format type (output) is JSON.

{
  "createCloudMssqlInstanceResponse": {
    "requestId": "c04bfdd1-e27e-4006-9bc3-bc37840ce1dd",
    "returnCode": 0,
    "returnMessage": "success",
    "totalRows": 1,
    "cloudMssqlInstanceList": [
      {
        "cloudMssqlInstanceNo": "****890",
        "cloudMssqlServiceName": "test-****",
        "cloudMssqlInstanceStatusName": "creating",
        "cloudMssqlInstanceStatus": {
          "code": "INIT",
          "codeName": "CLOUD DATABASE(VPC) Init State"
        },
        "cloudMssqlInstanceOperation": {
          "code": "CREAT",
          "codeName": "CLOUD DATABASE(VPC) Creat OP"
        },
        "generationCode": "G2",
        "cloudMssqlImageProductCode": "SW.VMSSL.OS.WND64.WINNT.SVR2016.MSSQL.15020005.SE.B100",
        "isHa": true,
        "isMultiZone": true,
        "license": {
          "code": "GPL",
          "codeName": "General Public License"
        },
        "cloudMssqlPort": 1433,
        "backupFileRetentionPeriod": 10,
        "backupTime": "00:15",
        "configGroupNo": "**9",
        "configGroupName": "test-****-config",
        "engineVersion": "MSSQL 15.0.2000.5 Standard Edition",
        "createDate": "2021-04-12T19:30:38+0900",
        "cloudMssqlServerInstanceList": [
          {
            "cloudMssqlServerName": "test-****-001-e04",
            "cloudMssqlServerRole": {
              "code": "M",
              "codeName": "Principal"
            },
            "cloudMssqlServerInstanceStatusName": "creating",
            "cloudMssqlServerInstanceStatus": {
              "code": "PEND",
              "codeName": "CLOUD DATABASE(VPC) Server Pending State"
            },
            "cloudMssqlServerInstanceOperation": {
              "code": "CREAT",
              "codeName": "CLOUD DATABASE(VPC) Server Create OP"
            },
            "regionCode": "KR",
            "zoneCode": "KR-1",
            "vpcNo": "****83",
            "subnetNo": "****91",
            "dataStorageSize": 10737418240,
            "cpuCount": 2,
            "memorySize": 8589934592,
            "isPublicSubnet": true,
            "cloudMssqlProductCode": "SVR.VMSSL.STAND.C002.M008.NET.HDD.B100.G002",
            "createDate": "2021-05-27T19:00:00+0900",
            "dataStorageType": {
              "code": "SSD",
              "codeName": "SSD"
            }
          },
          {
            "cloudMssqlServerName": "test-****-001-e05",
            "cloudMssqlServerRole": {
              "code": "H",
              "codeName": "Mirror"
            },
            "cloudMssqlServerInstanceStatusName": "creating",
            "cloudMssqlServerInstanceStatus": {
              "code": "PEND",
              "codeName": "CLOUD DATABASE(VPC) Server Pending State"
            },
            "cloudMssqlServerInstanceOperation": {
              "code": "CREAT",
              "codeName": "CLOUD DATABASE(VPC) Server Create OP"
            },
            "regionCode": "KR",
            "zoneCode": "KR-2",
            "vpcNo": "****83",
            "subnetNo": "****92",
            "dataStorageSize": 10737418240,
            "cpuCount": 2,
            "memorySize": 8589934592,
            "isPublicSubnet": true,
            "cloudMssqlProductCode": "SVR.VMSSL.STAND.C002.M008.NET.HDD.B100.G002",
            "createDate": "2021-05-27T19:00:00+0900",
            "dataStorageType": {
              "code": "SSD",
              "codeName": "SSD"
            }
          }
        ]
      }
    ]
  }
}

When response result format type (responseFormatType) is XML

The following is an example when the response result format type (responseFormatType) is XML.

<createCloudMssqlInstanceResponse>
    <requestId>c04bfdd1-e27e-4006-9bc3-bc37840ce1dd</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>1</totalRows>
    <cloudMssqlInstanceList>
        <cloudMssqlInstance>
            <cloudMssqlInstanceNo>****890</cloudMssqlInstanceNo>
            <cloudMssqlServiceName>test-****</cloudMssqlServiceName>
            <cloudMssqlInstanceStatusName>creating</cloudMssqlInstanceStatusName>
            <cloudMssqlInstanceStatus>
                <code>INIT</code>
                <codeName>CLOUD DATABASE(VPC) Init State</codeName>
            </cloudMssqlInstanceStatus>
            <cloudMssqlInstanceOperation>
                <code>CREAT</code>
                <codeName>CLOUD DATABASE(VPC) Creat OP</codeName>
            </cloudMssqlInstanceOperation>
            <generationCode>G2</generationCode>
            <cloudMssqlImageProductCode>SW.VMSSL.OS.WND64.WINNT.SVR2016.MSSQL.15020005.SE.B100</cloudMssqlImageProductCode>
            <isHa>true</isHa>
            <isMultiZone>true</isMultiZone>
            <license>
                <code>GPL</code>
                <codeName>General Public License</codeName>
            </license>
            <cloudMssqlPort>1433</cloudMssqlPort>
            <backupFileRetentionPeriod>10</backupFileRetentionPeriod>
            <backupTime>00:15</backupTime>
            <configGroupNo>**9</configGroupNo>
            <configGroupName>test-****-config</configGroupName>
            <engineVersion>MSSQL 15.0.2000.5 Standard Edition</engineVersion>
            <createDate>2021-04-12T19:30:38+0900</createDate>
            <cloudMssqlServerInstanceList>
                <cloudMssqlServerInstance>
                    <cloudMssqlServerName>test-****-001-e04</cloudMssqlServerName>
                    <cloudMssqlServerRole>
                        <code>M</code>
                        <codeName>Principal</codeName>
                    </cloudMssqlServerRole>
                    <cloudMssqlServerInstanceStatusName>creating</cloudMssqlServerInstanceStatusName>
                    <cloudMssqlServerInstanceStatus>
                        <code>PEND</code>
                        <codeName>CLOUD DATABASE(VPC) Server Pending State</codeName>
                    </cloudMssqlServerInstanceStatus>
                    <cloudMssqlServerInstanceOperation>
                        <code>CREAT</code>
                        <codeName>CLOUD DATABASE(VPC) Server Create OP</codeName>
                    </cloudMssqlServerInstanceOperation>
                    <regionCode>KR</regionCode>
                    <zoneCode>KR-1</zoneCode>
                    <vpcNo>****83</vpcNo>
                    <subnetNo>****91</subnetNo>
                    <dataStorageSize>10737418240</dataStorageSize>
                    <cpuCount>2</cpuCount>
                    <memorySize>8589934592</memorySize>
                    <isPublicSubnet>true</isPublicSubnet>
                    <cloudMssqlProductCode>SVR.VMSSL.STAND.C002.M008.NET.HDD.B100.G002</cloudMssqlProductCode>
                    <createDate>2021-05-27T19:00:00+0900</createDate>
                    <dataStorageType>
                        <code>SSD</code>
                        <codeName>SSD</codeName>
                    </dataStorageType>
                </cloudMssqlServerInstance><cloudMssqlServerInstance>
                <cloudMssqlServerName>test-****-001-e05</cloudMssqlServerName>
                <cloudMssqlServerRole>
                    <code>H</code>
                    <codeName>Mirror</codeName>
                </cloudMssqlServerRole>
                <cloudMssqlServerInstanceStatusName>creating</cloudMssqlServerInstanceStatusName>
                <cloudMssqlServerInstanceStatus>
                    <code>PEND</code>
                    <codeName>CLOUD DATABASE(VPC) Server Pending State</codeName>
                </cloudMssqlServerInstanceStatus>
                <cloudMssqlServerInstanceOperation>
                    <code>CREAT</code>
                    <codeName>CLOUD DATABASE(VPC) Server Create OP</codeName>
                </cloudMssqlServerInstanceOperation>
                <regionCode>KR</regionCode>
                <zoneCode>KR-2</zoneCode>
                <vpcNo>****83</vpcNo>
                <subnetNo>****92</subnetNo>
                <dataStorageSize>10737418240</dataStorageSize>
                <cpuCount>2</cpuCount>
                <memorySize>8589934592</memorySize>
                <isPublicSubnet>true</isPublicSubnet>
                <cloudMssqlProductCode>SVR.VMSSL.STAND.C002.M008.NET.HDD.B100.G002</cloudMssqlProductCode>
                <createDate>2021-05-27T19:00:00+0900</createDate>
                <dataStorageType>
                    <code>SSD</code>
                    <codeName>SSD</codeName>
                </dataStorageType>
            </cloudMssqlServerInstance>
            </cloudMssqlServerInstanceList>
        </cloudMssqlInstance>
    </cloudMssqlInstanceList>
</createCloudMssqlInstanceResponse>