Documentation Index

Fetch the complete documentation index at: https://cli.ncloud-docs.com/llms.txt

Use this file to discover all available pages before exploring further.

createCloudMssqlInstance

Prev Next

VPC環境で利用できます。

Cloud DB for MSSQLインスタンスを作成します。

構文

createCloudMssqlInstance構文は次の通りです。

./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>]

オプション

createCloudMssqlInstanceの実行時に指定できるオプションについて説明します。

必須オプション

createCloudMssqlInstanceの必須オプションです。

オプション タイプ 必須の有無 説明
--vpcNo String Required Cloud DB for MSSQLインスタンス作成対象の VPC番号
--subnetNo String Required Cloud DB for MSSQLインスタンスで使用する基本ネットワークインターフェースの Subnet番号
  • Publicドメインは、Public Subnetに作成された DBサーバでのみ申し込み可能
  • Cloud DB for MSSQLインスタンス作成後に Subnetの移転はできない
  • getCloudMssqlTargetSubnetListを参照
--cloudMssqlServiceName String Required Cloud DB for MSSQLサービス名
  • 英字、ハングル、数字、記号の-を組み合わせて3~15文字以内で入力
--cloudMssqlUserName String Required DB User ID
  • 英数字、記号の_を組み合わせて4~16文字以内で入力
  • 先頭文字は英字のみ使用
--cloudMssqlUserPassword String Required DB Userのパスワード
  • 英字、記号、数字をそれぞれ1文字以上含めて8~20文字以内で入力
  • 記号の` & \ " ' /とスペースは使用不可
--isHa Boolean Required 高可用性の有無
  • true (デフォルト) | false
    • true: Mirrorサーバを含めて2台のサーバが作成され、追加料金が発生
    • false: isMultiZonemirrorSubnetNoは使用不可
--mirrorSubnetNo String Conditional Mirrorサーバの Subnet番号
  • Cloud DB for MSSQLがマルチゾーンの場合、必ず入力
  • Principalサーバの Subnetとはゾーンが異なるように、Publicまたは Privateは同じようにする
  • getCloudMssqlTargetSubnetListを参照
--backupTime String Conditional バックアップ時点を設定(HH:MM)
  • isAutomaticBackup=falseの場合、必ず入力
  • 15分単位で入力可能
  • 例: 01:15

任意オプション

createCloudMssqlInstanceの任意オプションです。指定しない場合、オプションにはデフォルト値が適用されます。

オプション タイプ 必須の有無 説明
--isMultiZone Boolean Optional マルチゾーンかどうか
  • true | false (デフォルト)
    • true: Principalサーバと Mirrorを異なるゾーンに作成してより高い可用性を提供
    • false: マルチゾーンを使用しない
  • isHa=trueの場合にのみ使用可能
--configGroupNo String Optional Cloud DB for MSSQL Config Group番号
  • デフォルト: 0
  • 事前に作成しておいた Config Groupをサーバ作成時に適用可能
  • 別途 Config Groupがない場合、デフォルトで提供される Config Groupの中から選択可能
  • getCloudMssqlConfigGroupListを参照
--cloudMssqlImageProductCode String Optional Cloud DB for MSSQLイメージ商品コード
--cloudMssqlProductCode String Optional Cloud DB for MSSQL商品コード
  • Cloud DB for MSSQLインスタンスのサーバスペックを決める
  • デフォルト: 最小スペック(メモリ、CPUの順)
  • getCloudMssqlProductListを参照
--engineVersionCode String Optional DBエンジンのバージョン
--dataStorageTypeCode String Optional データストレージタイプコード
  • cloudMssqlImageProductCodegenerationCodeに応じて有効な値が異なる
    • G2: SSD (デフォルト) | HDD
    • G3: CB2 (デフォルト)
  • インストール後、データストレージタイプは変更不可
--characterSetName String Optional DBキャラクターセット
--isAutomaticBackup Boolean Optional バックアップ時点を自動設定するか
  • true (デフォルト) | false
  • trueの場合、backupTimeは入力不可
--backupFileRetentionPeriod Integer Optional バックアップファイルの保管期間(日)
  • 1~30 (デフォルト: 1)
  • バックアップは毎日行われ、バックアップファイルは別途ストレージに保存
  • 料金は使用する容量だけ課金
--cloudMssqlPort Integer Optional Cloud DB for MSSQLインスタンスアクセス用 TCPポート番号
  • 10000~20000 (デフォルト: 1433)

共通オプション

vmssqlコマンドで共通して使用するオプションについては、Cloud DB for MSSQL (VPC)のオプションを参照してください。

Cloud DB for MSSQLインスタンスの作成リクエストが成功すると、インスタンスの構成情報と作成状態が返されます。

コマンド

コマンドの例は次の通りです。

./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

出力

出力の例は次の通りです。

{
  "createCloudMssqlInstanceResponse": {
    "totalRows": 1,
    "cloudMssqlInstanceList": [
      {
        "cloudMssqlInstanceNo": "25280088",
        "cloudMssqlServiceName": "test-mssql-01",
        "cloudMssqlInstanceStatusName": "creating",
        "cloudMssqlInstanceStatus": {
          "code": "INIT",
          "codeName": "CLOUD DATABASE(VPC) Init状態"
        },
        "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": "ライセンスコード-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)サーバ Pending状態"
            },
            "cloudMssqlServerInstanceOperation": {
              "code": "CREAT",
              "codeName": "CLOUD DATABASE(VPC)サーバ 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)サーバ Pending状態"
            },
            "cloudMssqlServerInstanceOperation": {
              "code": "CREAT",
              "codeName": "CLOUD DATABASE(VPC)サーバ 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"
  }
}