--- title: "createCloudMssqlInstance" slug: "database-vmssql-createcloudmssqlinstance" tags: ["Cloud DB for MSSQL"] updated: 2026-09-17T09:57:51Z published: 2026-09-17T09:57:51Z canonical: "api.ncloud-docs.com/database-vmssql-createcloudmssqlinstance" --- > ## Documentation Index > Fetch the complete documentation index at: https://api.ncloud-docs.com/llms.txt > Use this file to discover all available pages before exploring further. # createCloudMssqlInstance VPC環境で利用できます。 Cloud DB for MSSQLインスタンスを作成します。 ## リクエスト リクエスト形式を説明します。リクエスト形式は次の通りです。 | メソッド | URI | | --- | --- | | GET \| POST | /vmssql/v2/createCloudMssqlInstance | 参考 ガイドは GETメソッドを基準に説明します。POSTメソッドの呼び出しテストは、NAVERクラウドプラットフォームコンソールの API Gatewayサービスの Swaggerで行えます。 ### リクエストヘッダ Cloud DB for MSSQL (VPC) APIで共通して使用されるヘッダの詳細は、[Cloud DB for MSSQL (VPC)のリクエストヘッダ](/docs/ja/database-vmssql#%EC%9A%94%EC%B2%AD%ED%97%A4%EB%8D%94)をご参照ください。 ### リクエストクエリパラメータ リクエストクエリパラメータの説明は次の通りです。 | フィールド | タイプ | 必須の有無 | 説明 | | --- | --- | --- | --- | | `regionCode` | String | Optional | 作成対象 Cloud DB for MSSQLインスタンスのリージョンコード - [getRegionList](/docs/ja/compute-vserver-server-common-getregionlist)を参照 - `getRegionList`照会結果の最初のリージョン(デフォルト) | | `vpcNo` | String | Required | Cloud DB for MSSQLインスタンス作成対象の VPC番号 - [getCloudMssqlTargetVpcList](/docs/ja/database-vmssql-getcloudmssqltargetvpclist)を参照 | | `subnetNo` | String | Required | Cloud DB for MSSQLインスタンスで使用するデフォルトのネットワークインターフェースの Subnet番号 - [getCloudMssqlTargetSubnetList](/docs/ja/database-vmssql-getcloudmssqltargetsubnetlist)を参照 - Publicドメインは、Public Subnetに作成された DBサーバでのみ申し込み可能 - Cloud DB for MSSQLインスタンス作成後に Subnetの移転はできない | | `mirrorSubnetNo` | String | Conditional | Mirrorサーバの Subnet番号 - Multi Zoneの CloudDB for MSSQLの場合、必ず入力 - [getCloudMssqlTargetSubnetList](/docs/ja/database-vmssql-getcloudmssqltargetsubnetlist)を参照 - Principalサーバの Subnetとはゾーンが異なるように、Publicまたは Privateは同じようにする | | `cloudMssqlServiceName` | String | Required | 作成する Cloud DB for MSSQLサービス名 - 英字、ハングル、数字、記号の「-」を組み合わせて3~15文字以内で入力 | | `configGroupNo` | String | Optional | Cloud DB for MSSQL Config Group番号 - 事前に作成しておいた Config Groupをサーバ作成時に適用可能 - 別途 Config Groupがない場合、デフォルトで提供される Config Groupの中から選択可能 - [getCloudMssqlConfigGroupList](/docs/ja/database-vmssql-getcloudmssqlconfiggrouplist)を参照 - 0 (デフォルト) | | `cloudMssqlImageProductCode` | String | Optional | Cloud DB for MSSQLイメージ商品コード - [getCloudMssqlImageProductList](/docs/ja/database-vmssql-getcloudmssqlimageproductlist)を参照 - NAVERクラウドプラットフォームで自動作成(デフォルト) | | `cloudMssqlProductCode` | String | Optional | Cloud DB for MSSQL商品コード - 作成対象 Cloud DB for MSSQLインスタンスのサーバスペックを決める - [getCloudMssqlProductList](/docs/ja/database-vmssql-getcloudmssqlproductlist)を参照 - 最小スペック(デフォルト) - 最小スペックの基準: 1. メモリ 2. CPUの順で決める | | `dataStorageTypeCode` | String | Optional | データストレージタイプコード - インストール後、データストレージタイプは変更不可 - `SSD` \| `HDD` \| `CB2` - `getCloudMssqlImageProduct`の generationCodeに応じてデフォルト値が異なる | | `isHa` | Boolean | Required | 高可用性の有無 - `true`(高可用性を選択)の場合、Mirrorサーバを含めて2台のサーバが作成され、追加料金が発生 - `false`の場合、`isMultiZone`、`mirrorSubnetNo`パラメータは使用されない | | `isMultiZone` | Boolean | Optional | Multi Zoneかどうか - `true` \| `false` (デフォルト) - 高可用性の有無(`isHa`)が`true`の場合にのみ入力可能 - `true`の場合、Principalサーバと Mirrorサーバを異なるゾーンに作成してより高い可用性を提供 | | `backupFileRetentionPeriod` | Integer | Optional | バックアップファイルの保管期間(日) - 1~30 (デフォルト: 1) - バックアップは毎日行われ、バックアップファイルは別途ストレージに保存 - 料金は使用する容量だけ課金 | | `backupTime` | String | Conditional | バックアップ時点を設定(HH:MM) - バックアップ時間自動設定の有無(`isAutomaticBackup`)が`false`の場合、必ず入力 - 15分単位で入力可能 - <例> 01:15 | | `isAutomaticBackup` | Boolean | Optional | バックアップ時点を自動設定するかどうか - `true` (デフォルト) \| `false` - `true`の場合、`backupTime`に関係なくバックアップ時間が自動で設定される | | `cloudMssqlUserName` | String | Required | DB Userアカウント ID - 英数字、記号の「_」を組み合わせて4~16文字以内で入力 - 先頭文字は英字にする | | `cloudMssqlUserPassword` | String | Required | DB Userアカウントパスワード - 英数字、記号をそれぞれ1文字以上含めて8~20文字以内で入力 - 記号の「` " ' \ / &」とスペースは使用不可 | | `cloudMssqlPort` | Integer | Optional | Cloud DB for MSSQLインスタンスにアクセスするための TCPポート番号 - `1433` (デフォルト) - 指定範囲: 10000~20000 | | `characterSetName` | String | Optional | DBキャラクターセット - [getCloudMssqlCharacterSetList](/docs/ja/database-vmssql-getcloudmssqlcharactersetlist)を参照 - ハングルと英字の collationの中から選択 - `Korean_Wansung_CI_AS` (デフォルト) \| `SQL_Latin1_General_CP1_CI_AS` - `Korean_Wansung_CI_AS`: ハングル完成型 - `SQL_Latin1_General_CP1_CI_AS`: 英字バージョン | | `engineVersionCode` | String | Conditional | DBエンジンのバージョン - [getCloudMssqlImageProductList](/docs/ja/database-vmssql-getcloudmssqlimageproductlist)を参照 - 入力しない場合、現在提供中の最新バージョンで作成 | | `responseFormatType` | String | Optional | レスポンス結果の形式 - `xml`(デフォルト) \| `json` | ### リクエスト例 リクエストのサンプルコードは次の通りです。 ``` curl --location --request GET 'https://ncloud.apigw.ntruss.com/vmssql/v2/createCloudMssqlInstance ?regionCode=KR &vpcNo=59*** &subnetNo=140*** &mirrorSubnetNo=158*** &cloudMssqlServiceName=mssql003 &configGroupNo=*** &cloudMssqlImageProductCode=SW.VMSSL.OS.WND64.WINNT.SVR2016.MSSQL.15043553.EE.B100 &cloudMssqlProductCode=SVR.VMSSL.HICPU.C002.M004.NET.HDD.B100.G002 &dataStorageTypeCode=SSD &isHa=true &isMultiZone=true &backupFileRetentionPeriod=1 &backupTime=10:15 &isAutomaticBackup=false &cloudMssqlUserName=user000 &cloudMssqlUserPassword=********* &cloudMssqlPort=1433 &characterSetName=Korean_Wansung_CI_AS &engineVersionCode=15.0.4355.3 &responseFormatType=json' \ --header 'x-ncp-apigw-timestamp: {Timestamp}' \ --header 'x-ncp-iam-access-key: {Access Key}' \ --header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' ``` ## レスポンス レスポンス形式を説明します。 ### レスポンスボディ レスポンスボディの詳細は、[CloudMssqlInstanceList](/docs/ja/common-vapidatatype-cloudmssqlinstancelist)をご参照ください。 ### レスポンスステータスコード Cloud DB for MSSQL (VPC) APIで共通して使用されるレスポンスステータスコードの詳細は、[Cloud DB for MSSQL (VPC)でのレスポンスステータスコード](/docs/ja/database-vmssql#%EC%9D%91%EB%8B%B5%EC%83%81%ED%83%9C%EC%BD%94%EB%93%9C)をご参照ください。 ### レスポンス例 レスポンスのサンプルコードは次の通りです。 - `responseFormatType=json`の場合 ``` { "createCloudMssqlInstanceResponse": { "totalRows": 1, "cloudMssqlInstanceList": [ { "cloudMssqlInstanceNo": "2528****", "cloudMssqlServiceName": "mssql003", "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.15043553.EE.B100", "isHa": true, "isMultiZone": true, "license": { "code": "SPLA", "codeName": "Service Provider License Agreement" }, "cloudMssqlPort": 1433, "backupFileRetentionPeriod": 1, "backupTime": "10:15", "configGroupNo": "***", "configGroupName": "mssql_2019_default", "engineVersion": "MSSQL 15.0.4355.3 Enterprise Edition", "createDate": "2024-07-01T11:34:11+0900", "dbCollation": "Korean_Wansung_CI_AS", "cloudMssqlServerInstanceList": [ { "cloudMssqlServerName": "m-2528****-001", "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": "59***", "subnetNo": "140***", "dataStorageSize": 107374182400, "cpuCount": 2, "memorySize": 4294967296, "isPublicSubnet": true, "cloudMssqlProductCode": "SVR.VMSSL.HICPU.C002.M004.NET.HDD.B100.G002", "createDate": "2024-07-01T11:34:11+0900", "dataStorageType": { "code": "SSD", "codeName": "SSD" } }, { "cloudMssqlServerName": "m-2528****-002", "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": "59***", "subnetNo": "158***", "dataStorageSize": 107374182400, "cpuCount": 2, "memorySize": 4294967296, "isPublicSubnet": true, "cloudMssqlProductCode": "SVR.VMSSL.HICPU.C002.M004.NET.HDD.B100.G002", "createDate": "2024-07-01T11:34:11+0900", "dataStorageType": { "code": "SSD", "codeName": "SSD" } } ] } ], "requestId": "7e05dba1-****-****-****-e463eb447507", "returnCode": "0", "returnMessage": "success" } } ``` - `responseFormatType=xml`(デフォルト)の場合 ``` 7e05dba1-****-****-****-e463eb447507 0 success 1 2528**** mssql003 creating INIT CLOUD DATABASE(VPC) Init State CREAT CLOUD DATABASE(VPC) Creat OP G2 SW.VMSSL.OS.WND64.WINNT.SVR2016.MSSQL.15043553.EE.B100 true true SPLA Service Provider License Agreement 1433 1 10:15 *** mssql_2019_default MSSQL 15.0.4355.3 Enterprise Edition 2024-07-01T11:34:11+0900 Korean_Wansung_CI_AS m-2528****-001 M Principal creating PEND CLOUD DATABASE(VPC) Server Pending State CREAT CLOUD DATABASE(VPC) Server Create OP KR KR-1 59*** 140*** 107374182400 2 4294967296 true SVR.VMSSL.HICPU.C002.M004.NET.HDD.B100.G002 2024-07-01T11:34:11+0900 SSD SSD m-2528****-002 H Mirror creating PEND CLOUD DATABASE(VPC) Server Pending State CREAT CLOUD DATABASE(VPC) Server Create OP KR KR-2 59*** 158*** 107374182400 2 4294967296 true SVR.VMSSL.HICPU.C002.M004.NET.HDD.B100.G002 2024-07-01T11:34:11+0900 SSD SSD ```