createCloudMssqlInstance

Available in VPC

Create a Cloud DB for MSSQL instance.

Syntax

The createCloudMssqlInstance syntax is as follows:

./ncloud vmssql createCloudMssqlInstance \
    --vpcNo <vpc-no> \
    --subnetNo <subnet-no> \
    --cloudMssqlServiceName <service-name> \
    --cloudMssqlUserName <user-name> \
    --cloudMssqlUserPassword <user-password> \
    --isHa <true|false> \
    [--isMultiZone <true|false>] \
    [--mirrorSubnetNo <mirror-subnet-no>] \
    [--configGroupNo <config-group-no>] \
    [--cloudMssqlImageProductCode <image-product-code>] \
    [--cloudMssqlProductCode <product-code>] \
    [--engineVersionCode <engine-version-code>] \    
    [--dataStorageTypeCode <SSD|HDD|CB2>] \
    [--characterSetName <character-set-name>] \
    [--isAutomaticBackup <true|false>] \    
    [--backupTime <hh:mm>] \    
    [--backupFileRetentionPeriod <retention-days>] \
    [--cloudMssqlPort <port>] \
    [--regionCode <KR|SGN|JPN>] \
    [--output <json|xml>]

Options

This section describes the options available when running createCloudMssqlInstance.

Required options

The following options are required for createCloudMssqlInstance.

Options	Type	Required	Description
`--vpcNo`	String	Required	Number of VPC to create the Cloud DB for MSSQL instance in See getCloudMssqlTargetVpcList.
`--subnetNo`	String	Required	Subnet number of the default network interface to be used in the Cloud DB for MSSQL instance Subscription to public domains can only be done in a DB server created in public subnet. Subnet migrations are not available after creating the Cloud DB for MSSQL instance. See getCloudMssqlTargetSubnetList.
`--cloudMssqlServiceName`	String	Required	Cloud DB for MSSQL service name Enter 3-15 characters, including English letters, Korean letters, numbers, and special character `-`.
`--cloudMssqlUserName`	String	Required	DB user ID Enter 4-16 characters, including English letters, numbers, and special character `_`. The string must begin with an English letter.
`--cloudMssqlUserPassword`	String	Required	DB user password Enter 8-20 characters containing at least one English letter, number, and special character. Special characters ` `&` `\` `"` `'` `/` and spaces can't be used.
`--isHa`	Boolean	Required	High availability status `true` (default) \| `false` `true`: It creates two servers, including a mirror server, and incurs additional fees. `false`: `isMultiZone` and `mirrorSubnetNo` are unavailable.
`--mirrorSubnetNo`	String	Conditional	Subnet number of the mirror server Must be entered for multi-zone Cloud DB for MSSQL. It must be in a different zone from the principal server's subnet, but the public or private status must match. See getCloudMssqlTargetSubnetList.
`--backupTime`	String	Conditional	Set backup time (HH:MM). Required if `isAutomaticBackup`=`false`. Enter in 15 minute increments. e.g., `01:15`

Optional options

These are the optional options for createCloudMssqlInstance. Options that are not specified will use their default values.

Options	Type	Required	Description
`--isMultiZone`	Boolean	Optional	Multi-zone status `true` \| `false` (default) `true`: Create the principal and mirror servers in separate zones to provide higher availability. `false`: Multi-zone not enabled. Available only if `isHa`=`true`.
`--configGroupNo`	String	Optional	Cloud DB for MSSQL config group number Default: `0` 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. See getCloudMssqlConfigGroupList.
`--cloudMssqlImageProductCode`	String	Optional	Cloud DB for MSSQL image product code Automatically generated by NAVER Cloud Platform (default). See getCloudMssqlImageProductList.
`--cloudMssqlProductCode`	String	Optional	Cloud DB for MSSQL product code Determine the server specifications for the Cloud DB for MSSQL instance. Default: Minimum specifications (in the order of memory, CPU). See getCloudMssqlProductList.
`--engineVersionCode`	String	Optional	DB engine version If not entered, it is created with the latest version currently available. See getCloudMssqlImageProductList.
`--dataStorageTypeCode`	String	Optional	Data storage type code Valid values vary depending on the `generationCode` of `cloudMssqlImageProductCode`. G2: `SSD` (default) \| `HDD` G3: `CB2` (default) You cannot change the data storage type after installation.
`--characterSetName`	String	Optional	DB character set `Korean_Wansung_CI_AS` (default) \| `SQL_Latin1_General_CP1_CI_AS` See getCloudMssqlCharacterSetList.
`--isAutomaticBackup`	Boolean	Optional	Whether to set the backup time automatically `true` (default) \| `false` If set to `true`, `backupTime` can't be entered.
`--backupFileRetentionPeriod`	Integer	Optional	Backup file retention period (days) `1`-`30` (default: `1`) Backup is performed every day, and the backup file is stored in a separate backup storage. Fees are charged for the space you use.
`--cloudMssqlPort`	Integer	Optional	TCP port number to access the Cloud DB for MSSQL instance `10000`-`20000` (default: `1433`)

Common options

For information about the options common to all vmssql subcommands, see Cloud DB for MSSQL (VPC) options.

Examples

If the request to create a Cloud DB for MSSQL instance is successful, the instance's configuration information and creation status are returned.

Command

The command example is as follows:

./ncloud vmssql createCloudMssqlInstance \
    --vpcNo 12345678 \
    --subnetNo 23456789 \
    --cloudMssqlServiceName test-mssql-01 \
    --cloudMssqlUserName testuser \
    --cloudMssqlUserPassword Examplepw123! \
    --isHa true \
    --cloudMssqlImageProductCode SW.VMSSL.OS.WND64.WINNT.SVR2016.MSSQL.15044401.SE.B100 \
    --cloudMssqlProductCode SVR.VMSSL.HICPU.C002.M004.NET.HDD.B100.G002 \
    --regionCode KR \
    --output json

Output

The output example is as follows:

{
  "createCloudMssqlInstanceResponse": {
    "totalRows": 1,
    "cloudMssqlInstanceList": [
      {
        "cloudMssqlInstanceNo": "25280088",
        "cloudMssqlServiceName": "test-mssql-01",
        "cloudMssqlInstanceStatusName": "creating",
        "cloudMssqlInstanceStatus": {
          "code": "INIT",
          "codeName": "CLOUD DATABASE (VPC) Init status"
        },
        "cloudMssqlInstanceOperation": {
          "code": "CREAT",
          "codeName": "CLOUD DATABASE(VPC) Creat OP"
        },
        "generationCode": "G2",
        "cloudMssqlImageProductCode": "SW.VMSSL.OS.WND64.WINNT.SVR2016.MSSQL.15044401.SE.B100",
        "isHa": true,
        "isMultiZone": false,
        "license": {
          "code": "SPLA",
          "codeName": "License code - CLOUD DATABASE (VPC)"
        },
        "cloudMssqlPort": 1433,
        "backupFileRetentionPeriod": 1,
        "backupTime": "09:00",
        "configGroupNo": "0",
        "configGroupName": "mssql_2019_default",
        "engineVersion": "MSSQL 15.0.4440.1 Standard Edition",
        "createDate": "2026-06-09T19:47:07+0900",
        "dbCollation": "Korean_Wansung_CI_AS",
        "cloudMssqlServerInstanceList": [
          {
            "cloudMssqlServerName": "m-25280088-001",
            "cloudMssqlServerRole": {
              "code": "M",
              "codeName": "Principal"
            },
            "cloudMssqlServerInstanceStatusName": "creating",
            "cloudMssqlServerInstanceStatus": {
              "code": "PEND",
              "codeName": "CLOUD DATABASE (VPC) server Pending status"
            },
            "cloudMssqlServerInstanceOperation": {
              "code": "CREAT",
              "codeName": "CLOUD DATABASE (VPC) server Create OP"
            },
            "regionCode": "KR",
            "zoneCode": "KR-1",
            "vpcNo": "12345678",
            "subnetNo": "23456789",
            "dataStorageSize": 107374182400,
            "cpuCount": 2,
            "memorySize": 4294967296,
            "isPublicSubnet": false,
            "cloudMssqlProductCode": "SVR.VMSSL.HICPU.C002.M004.NET.HDD.B100.G002",
            "createDate": "2026-06-09T19:47:07+0900",
            "dataStorageType": {
              "code": "SSD",
              "codeName": "SSD"
            }
          },
          {
            "cloudMssqlServerName": "m-25280088-002",
            "cloudMssqlServerRole": {
              "code": "H",
              "codeName": "Mirror"
            },
            "cloudMssqlServerInstanceStatusName": "creating",
            "cloudMssqlServerInstanceStatus": {
              "code": "PEND",
              "codeName": "CLOUD DATABASE (VPC) server Pending status"
            },
            "cloudMssqlServerInstanceOperation": {
              "code": "CREAT",
              "codeName": "CLOUD DATABASE (VPC) server Create OP"
            },
            "regionCode": "KR",
            "zoneCode": "KR-1",
            "vpcNo": "12345678",
            "subnetNo": "23456789",
            "dataStorageSize": 107374182400,
            "cpuCount": 2,
            "memorySize": 4294967296,
            "isPublicSubnet": false,
            "cloudMssqlProductCode": "SVR.VMSSL.HICPU.C002.M004.NET.HDD.B100.G002",
            "createDate": "2026-06-09T19:47:07+0900",
            "dataStorageType": {
              "code": "SSD",
              "codeName": "SSD"
            }
          }
        ]
      }
    ],
    "requestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "returnCode": "0",
    "returnMessage": "success"
  }
}