createCloudMssqlInstance
    • PDF

    createCloudMssqlInstance

    • PDF

    記事の要約

    VPC環境で利用できます。

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

    リクエスト

    リクエスト形式を説明します。リクエスト形式は次の通りです。

    メソッドURI
    GET, POST/createCloudMssqlInstance

    リクエストヘッダ

    Cloud DB for MSSQL (VPC) APIで共通して使用されるヘッダの詳細は、Cloud DB for MSSQL (VPC)のリクエストヘッダをご参照ください。

    リクエストパラメータ

    パラメータの説明は次の通りです。

    フィールドタイプ必須の有無説明
    regionCodeStringOptional作成対象の Cloud DB for MSSQLインスタンスのリージョンコード
    • getRegionListを通じて確認
    • getRegionList照会結果の最初のリージョン(デフォルト)
    vpcNoStringRequiredCloud DB for MSSQLインスタンス作成対象の VPC番号
    subnetNoStringRequiredCloud DB for MSSQLインスタンスで使用する基本ネットワークインターフェースの Subnet番号
    • getCloudMssqlTargetSubnetListを通じて確認
    • Publicドメインは、Public Subnetに作成された DBサーバでのみ申し込み可能
    • Cloud DB for MSSQLインスタンス作成後に Subnetの移転はできない
    mirrorSubnetNoStringConditionalMirrorサーバの Subnet番号
    • Multi Zoneの CloudDB for MSSQLの場合、必ず入力
    • getCloudMssqlTargetSubnetListを通じて確認
    • Principalサーバの Subnetとはゾーンが異なるように、Publicまたは Privateは同じようにする
    cloudMssqlServiceNameStringRequired作成する Cloud DB for MSSQLサービス名
    • 英数字、ハングル、記号の「-」のみ使用して3~15文字以内で入力
    configGroupNoStringOptionalCloud DB for MSSQL Config Group番号
    • 事前に作成しておいた Config Groupをサーバ作成時に適用可能
    • 別途 Config Groupがない場合、デフォルトで提供される Config Groupの中から選択可能
    • getCloudMssqlConfigGroupListを通じて確認
    • 0 (デフォルト)
    cloudMssqlImageProductCodeStringOptionalCloud DB for MSSQLイメージ商品コード
    cloudMssqlProductCodeStringOptionalCloud DB for MSSQL商品コード
    • 作成対象の Cloud DB for MSSQLインスタンスのサーバスペックを決める
    • getCloudMssqlProductListを通じて確認
    • 最小スペック(デフォルト)
    • 最小スペックの基準: 1. メモリ 2. CPUの順で決める
    dataStorageTypeCodeStringOptionalデータストレージタイプコード
    • インストール後にデータストレージタイプは変更不可
    • SSD (デフォルト) | HDD
    isHaBooleanRequired高可用性の有無
    • true(高可用性を選択)の場合、Mirrorサーバを含めて2台のサーバが作成され、追加料金が発生
    • falseの場合、isMultiZonemirrorSubnetNoパラメータは使用されない
    isMultiZoneBooleanOptionalMulti Zoneかどうか
    • true | false (デフォルト)
      • 高可用性の有無(isHa)がtrueの場合にのみ入力可能
      • trueの場合、Principalサーバと Mirrorサーバを異なるゾーンに作成してより高い可用性を提供
    backupFileRetentionPeriodIntegerOptionalバックアップファイルの保管期間(日)
    • 1~30 (デフォルト: 1)
    • バックアップは毎日行われ、バックアップファイルは別途ストレージに保存
    • 料金は使用する容量だけ課金
    backupTimeStringConditionalバックアップ時点を設定(HH:MM)
    • バックアップ時間自動設定の有無(isAutomaticBackup)がfalseの場合、必ず入力
    • 15分単位で入力可能
    • <例> 01:15
    isAutomaticBackupBooleanOptionalバックアップ時点を自動設定するかどうか
    • true (デフォルト) | false
      • trueの場合、backupTimeに関係なくバックアップ時間が自動で設定される
    cloudMssqlUserNameStringRequiredDB Userアカウント ID
    • 英数字、記号の「_」を使用して4~16文字以内で入力、先頭文字は英字にする
    cloudMssqlUserPasswordStringRequiredDB Userアカウントパスワード
    • 英数字、記号をそれぞれ1文字以上含めて8~20文字以内で入力
    • 記号の「` " ' \ / &」とスペースは使用不可
    cloudMssqlPortIntegerOptionalCloud DB for MSSQLインスタンスにアクセスするための TCPポート番号
    • 1433 (デフォルト)
    • 指定範囲: 10000~20000
    characterSetNameStringOptionalDBキャラクターセット
    • getCloudMssqlCharacterSetListを通じて確認
    • ハングルと英語の collationの中から選択
    • Korean_Wansung_CI_AS (デフォルト) | SQL_Latin1_General_CP1_CI_AS
      • Korean_Wansung_CI_AS: ハングル完成型
      • SQL_Latin1_General_CP1_CI_AS: 英字バージョン
    responseFormatTypeStringOptionalレスポンス結果の形式
    • 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
    &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>
      

    この記事は役に立ちましたか?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.