createCloudMssqlInstance

Article Summary

Share feedback

Thanks for sharing your feedback!

Available in VPC

Create a Cloud DB for MSSQL instance.

Requests

Request Parameters

Parameter	Type	Requirement Status	Description	Restrictions
regionCode	String	N	Region code - regionCode can be obtained via the getRegionList action - default: Selects the first region of the getRegionList query results	-
vpcNo	String	Y	VPC number - vpcNo can be obtained via the getCloudMssqlTargetVpcList action	-
subnetNo	String	Y	Subnet number - subnetNo can be obtained via the getCloudMssqlTargetSubnetList action - Public domain can only be used on a DB server generated on Public Subnet - Subnet transfer is not available after creating an instance	-
mirrorSubnetNo	String	N	Subnet number of the mirror server - When multi-zone (isMultiZone) is false, input is not accepted. When multi-zone (isMultiZone) is true, you must enter - mirrorSubnetNo must have a different zone from the principle server's subnet, and their public or private statuses must match - mirrorSubnetNo can be obtained via the getCloudMssqlTargetSubnetList action	-
cloudMssqlServiceName	String	Y	Cloud DB for MSSQL service name	- Only English alphabets, numbers, dash ( - ) and Korean letters can be entered - Min: 3 - Max: 15
configGroupNo	String	N	Cloud DB for MSSQL config group Number - Already-created Config Group can be applied when creating a server - When you do not have any config groups, you can select from provided config groups by default - You can view through getCloudMssqlConfigGroupList - default: 0	-
cloudMssqlImageProductCode	String	N	Cloud DB for MSSQL image product code - cloudMssqlImageProductCode can be obtained via the getCloudMssqlImageProductList action's productCode - Generated in default value if data is not entered	-
cloudMssqlProductCode	String	N	Cloud DB for MSSQL product code - Set the server specifications of the Cloud DB for MSSQL instance to be created - cloudMssqlProductCode can be obtained via the getCloudMssqlProductList action's productCode - default: Selected as the minimum specification. The minimum specification is based on 1. memory and 2. CPU	-
dataStorageTypeCode	String	N	Data storage type code - Data storage type cannot be altered after installation - options: SSD or HDD - default: SSD	-
isHa	Boolean	Y	High availability status - If high availability is selected, 2 servers including a standby master server are generated, and additional charges will be incurred - default: true	-
isMultiZone	Boolean	N	Multi-zone (True/False) - If the high availability status (isHa) is true, multi-zone status can be selected - If multi-zone is selected, the principle server and mirror server are created in different zones to provide higher availability - Must be entered if the high availability status (isHa) is true - default: false	-
backupFileRetentionPeriod	Integer	N	Backup file storage period - Backups are performed every day, and backup files are saved in a separate backup storage - Charges are based on the storage space used - default: 1 (1 day)	- Min: 1 - Max: 30
backupTime	String	N	Backup time - Sets the backup time. If automatic backup (isAutomaticBackup) is false, input is required - 01:15	- HHMM format. You must enter in 15-minute increments
isAutomaticBackup	Boolean	N	Backup time is automatically set - Select whether to have backup times set automatically - When the automatic backup status (isAutomaticBackup) is true, any backupTime entered is ignored and the backup time is configured automatically	-
cloudMssqlUserName	String	Y	Access user name - Enter user name to use for DB admin	- Only English letters, numbers, and underscore characters ( _ ) are allowed, and must start with an English letter - Min: 4 - Max: 16
cloudMssqlUserPassword	String	Y	Access password - Enter user's password to use for DB admin	- Must be at least 8 characters in length and contain at least 1 each of English letter, special character, and number - The following characters cannot be used in the password: ` & \ " ' / and space - Min: 8 - Max: 20
cloudMssqlPort	Integer	N	Cloud DB for MSSQL port - Enter the TCP port number for MSSQL access - default: 1433	1433 or - Min: 10000 - Max: 20000
characterSetName	String	N	DB character set - DB character set can be selected from Korean and English collation - You can view through getCloudMssqlCharacterSetList API - default: Korean_Wansung_CI_AS	-
responseFormatType	String	N	Format type of the response result - options: xml \| json - default: xml	-

Responses

Response bodies

For response bodies, refer to CloudMssqlInstanceList.

Examples

Request Examples

The following is an example of a request body.

GET {API_URL}/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

Response examples

The following are examples of responses.

If the response shows that format type (responseFormatType) 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"
        },
        "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"
            }
          }
        ]
      }
    ]
  }
}

If the response shows that 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>
            <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>

Was this article helpful?

What's Next

createCloudMssqlSlaveInstance

Table of contents

Requests
Responses
Examples