createCloudMssqlInstance
- 印刷する
- PDF
createCloudMssqlInstance
- 印刷する
- PDF
記事の要約
この要約は役に立ちましたか?
ご意見ありがとうございます
VPC環境で利用できます。
Cloud DB for MSSQLインスタンスを作成します。
リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
メソッド | URI |
---|---|
GET, POST | /createCloudMssqlInstance |
リクエストヘッダ
Cloud DB for MSSQL (VPC) APIで共通して使用されるヘッダの詳細は、Cloud DB for MSSQL (VPC)のリクエストヘッダをご参照ください。
リクエストパラメータ
パラメータの説明は次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
regionCode | String | Optional | 作成対象の Cloud DB for MSSQLインスタンスのリージョンコード
|
vpcNo | String | Required | Cloud DB for MSSQLインスタンス作成対象の VPC番号 |
subnetNo | String | Required | Cloud DB for MSSQLインスタンスで使用する基本ネットワークインターフェースの Subnet番号
|
mirrorSubnetNo | String | Conditional | Mirrorサーバの Subnet番号
|
cloudMssqlServiceName | String | Required | 作成する Cloud DB for MSSQLサービス名
|
configGroupNo | String | Optional | Cloud DB for MSSQL Config Group番号
|
cloudMssqlImageProductCode | String | Optional | Cloud DB for MSSQLイメージ商品コード
|
cloudMssqlProductCode | String | Optional | Cloud DB for MSSQL商品コード
|
dataStorageTypeCode | String | Optional | データストレージタイプコード
|
isHa | Boolean | Required | 高可用性の有無
|
isMultiZone | Boolean | Optional | Multi Zoneかどうか
|
backupFileRetentionPeriod | Integer | Optional | バックアップファイルの保管期間(日)
|
backupTime | String | Conditional | バックアップ時点を設定(HH:MM)
|
isAutomaticBackup | Boolean | Optional | バックアップ時点を自動設定するかどうか
|
cloudMssqlUserName | String | Required | DB Userアカウント ID
|
cloudMssqlUserPassword | String | Required | DB Userアカウントパスワード
|
cloudMssqlPort | Integer | Optional | Cloud DB for MSSQLインスタンスにアクセスするための TCPポート番号
|
characterSetName | String | Optional | DBキャラクターセット
|
responseFormatType | String | Optional | レスポンス結果の形式
|
リクエスト例
リクエストのサンプルコードは次の通りです。
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
&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をご参照ください。
レスポンスステータスコード
NAVERクラウドプラットフォームでで共通して使用されるレスポンスステータスコードの詳細は、Ncloud APIのレスポンスステータスコードをご参照ください。
レスポンス例
レスポンスのサンプルコードは次の通りです。
responseFormetType=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" }, "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" } }
responseFormetType=xml
(デフォルト)の場合<?xml version="1.0" encoding="UTF-8"?> <createCloudMssqlInstanceResponse> <requestId>7e05dba1-****-****-****-e463eb447507</requestId> <returnCode>0</returnCode> <returnMessage>success</returnMessage> <totalRows>1</totalRows> <cloudMssqlInstanceList> <cloudMssqlInstance> <cloudMssqlInstanceNo>2528****</cloudMssqlInstanceNo> <cloudMssqlServiceName>mssql003</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.15043553.EE.B100</cloudMssqlImageProductCode> <isHa>true</isHa> <isMultiZone>true</isMultiZone> <license> <code>SPLA</code> <codeName>Service Provider License Agreement</codeName> </license> <cloudMssqlPort>1433</cloudMssqlPort> <backupFileRetentionPeriod>1</backupFileRetentionPeriod> <backupTime>10:15</backupTime> <configGroupNo>***</configGroupNo> <configGroupName>mssql_2019_default</configGroupName> <engineVersion>MSSQL 15.0.4355.3 Enterprise Edition</engineVersion> <createDate>2024-07-01T11:34:11+0900</createDate> <dbCollation>Korean_Wansung_CI_AS</dbCollation> <cloudMssqlServerInstanceList> <cloudMssqlServerInstance> <cloudMssqlServerName>m-2528****-001</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>59***</vpcNo> <subnetNo>140***</subnetNo> <dataStorageSize>107374182400</dataStorageSize> <cpuCount>2</cpuCount> <memorySize>4294967296</memorySize> <isPublicSubnet>true</isPublicSubnet> <cloudMssqlProductCode>SVR.VMSSL.HICPU.C002.M004.NET.HDD.B100.G002</cloudMssqlProductCode> <createDate>2024-07-01T11:34:11+0900</createDate> <dataStorageType> <code>SSD</code> <codeName>SSD</codeName> </dataStorageType> </cloudMssqlServerInstance> <cloudMssqlServerInstance> <cloudMssqlServerName>m-2528****-002</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>59***</vpcNo> <subnetNo>158***</subnetNo> <dataStorageSize>107374182400</dataStorageSize> <cpuCount>2</cpuCount> <memorySize>4294967296</memorySize> <isPublicSubnet>true</isPublicSubnet> <cloudMssqlProductCode>SVR.VMSSL.HICPU.C002.M004.NET.HDD.B100.G002</cloudMssqlProductCode> <createDate>2024-07-01T11:34:11+0900</createDate> <dataStorageType> <code>SSD</code> <codeName>SSD</codeName> </dataStorageType> </cloudMssqlServerInstance> </cloudMssqlServerInstanceList> </cloudMssqlInstance> </cloudMssqlInstanceList> </createCloudMssqlInstanceResponse>
この記事は役に立ちましたか?