createCloudMssqlInstance

Prev Next

VPC環境で利用できます。

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

コマンド

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

ncloud vmssql createCloudMssqlInstance [regionCode] [vpcNo] [subnetNo] [mirrorSubnetNo] [cloudMssqlServiceName] [configGroupNo] [cloudMssqlImageProductCode] [cloudMssqlProductCode] [dataStorageTypeCode] [isHa] [isMultiZone] [backupFileRetentionPeriod] [backupTime] [isAutomaticBackup] [cloudMssqlUserName] [cloudMssqlUserPassword] [cloudMssqlPort] [characterSetName] [engineVersionCode] [output]

パラメータ

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

パラメータ タイプ 必須の有無 説明 制限事項
regionCode String N リージョンコード
  • regionCodeはgetRegionListアクションを通じて取得
  • デフォルト: getRegionList照会結果の最初のリージョンを選択
 -
vpcNo String Y VPC番号 -
subnetNo String Y Subnet番号
  • subnetNoはgetCloudMssqlTargetSubnetListアクションを通じて取得
  • Publicドメインは、Public Subnetに作成された DBサーバでのみ申し込み可能
  • Cloud DB for MSSQLインスタンス作成後に Subnetの移転はできない
 -
mirrorSubnetNo String N Mirrorサーバの Subnet番号
  • マルチゾーンの有無(isMultiZone)が falseの場合は入力せず、マルチゾーンの有無(isMultiZone)が trueの場合、必ず入力
  • mirrorSubnetNoは Principalサーバの Subnetと Zoneを異にし、同じ Publicか Privateにする
  • mirrorSubnetNoはgetCloudMssqlTargetSubnetListアクションを通じて取得
 -
cloudMssqlServiceName String Y Cloud DB for MSSQLサービス名
  • 英数字、ハイフン「-」、ハングルのみ入力可能
  • 最小: 3
  • 最大: 15
configGroupNo String N Cloud DB for MSSQL Config Group番号
  • 事前に作成しておいた Config Groupをサーバ作成時に適用
  • 別途 Config Groupがない場合、デフォルトで提供されるものを選択可能
  • getCloudMssqlConfigGroupListを通じて照会可能
  • デフォルト: 0
 -
cloudMssqlImageProductCode String N Cloud DB for MSSQLイメージ商品コード
  • cloudMssqlImageProductCodeはgetCloudMssqlImageProductListアクションの productCodeで取得
  • 入力しない場合、デフォルト値で作成
 -
cloudMssqlProductCode String N Cloud DB for MSSQL商品コード
  • 作成する Cloud DB for MSSQLインスタンスのサーバスペックを決定
  • cloudMssqlProductCodeはgetCloudMssqlProductListアクションの productCodeで取得
  • デフォルト: 最低スペックを選択。最低スペックの基準は、1. メモリ、2. CPU
 -
dataStorageTypeCode String N データストレージタイプコード
  • インストール後にデータストレージタイプは変更不可
  • オプション
    • cloudMssqlImageProductCodeの generationCodeが G2の場合: SSD | HDD
    • cloudMssqlImageProductCodeの generationCodeが G3の場合: CB2
  • デフォルト
    • cloudMssqlImageProductCodeの generationCodeが G2の場合: SSD
    • cloudMssqlImageProductCodeの generationCodeが G3の場合: CB2
-
isHa Boolean Y 高可用性の有無
  • 高可用性を選択すると、Standby Masterサーバを含めて2台のサーバが作成され、追加料金が発生
  • デフォルト: true
 -
isMultiZone Boolean N マルチゾーンの有無
  • 高可用性の有無(isHa)が trueの場合、マルチゾーンの有無を選択
  • マルチゾーンを選択すると、Masterサーバと Standby Masterサーバを異なる Zoneに作成してより高い可用性を提供
  • 高可用性の有無(isHa)が trueの場合、必ず入力
  • デフォルト: false
 -
backupFileRetentionPeriod Integer N バックアップファイルの保管期間
  • バックアップは毎日行われ、バックアップファイルは別途のバックアップストレージに保存
  • 料金は使用する容量だけ課金
  • デフォルト: 1(1日)
  • 最小: 1
  • 最大: 30
backupTime String N バックアップ時間
  • バックアップが実行される時間を設定、自動バックアップの有無(isAutomaticBackup)が falseであれば、必ず入力
  • 01:15
  • HHMM形式。15分単位のみ入力可能
isAutomaticBackup Boolean N バックアップ時間の自動有無
  • 自動でバックアップ時間を設定するかどうかを選択
  • バックアップ自動設定の有無(isAutomaticBackup)が trueの場合、backupTimeが入力されても無視され、自動設定
 -
cloudMssqlUserName String Y アクセスユーザー名
  • DB管理者用として使用するユーザーを入力
  • 英数字、記号の「_」のみ使用可能で、先頭文字は英字のみ使用
  • 最小: 4
  • 最大: 16
cloudMssqlUserPassword String Y アクセスパスワード
  • DB管理者用として使用するユーザーのパスワードを入力
  • 8文字以上、英字、数字、記号の3つの項目をそれぞれ1文字以上必ず含めること
  • ` & \ " ' /とスペースはパスワードに使用不可
  • 最小: 8
  • 最大: 20
cloudMssqlPort Integer N Cloud DB for MSSQLポート
  • MSSQLにアクセスするための TCPポート番号を入力
  • デフォルト: 1433
 1433
  • 最小: 10000
  • 最大: 20000
characterSetName String N DBキャラクターセット
  • DBキャラクターセットはハングルと英語の collationの中から選択
  • getCloudMssqlCharacterSetList APIを通じて照会可能
  • デフォルト: Korean_Wansung_CI_AS
 -
engineVersionCode String N DBエンジンのバージョン -
output String N レスポンス結果の形式タイプ
  • オプション: xml | json
  • デフォルト: json
 -

レスポンス

レスポンスデータタイプ

  • CloudMssqlInstanceListタイプ

    CloudMssqlInstanceList extends CommonResponse 説明
    private Integer totalRows; 照会されたリストの総数
    private List<CloudMssqlInstance> cloudMssqlInstanceList = new ArrayList<>(); Cloud DB for MSSQLインスタンスリスト

  • CloudMssqlInstanceタイプ

    CloudMssqlInstance 説明
    private String cloudMssqlInstanceNo; Cloud DB for MSSQLインスタンス番号
    private String cloudMssqlServiceName; Cloud DB for MSSQLサービス名
    private String cloudMssqlInstanceStatusName; Cloud DB for MSSQLインスタンスの状態名
    • creating
    • deleted
    • deleting
    • downgrading
    • pending
    • recovering
    • reinstalling
    • restarting
    • running
    • settingup
    • shuttingdown
    • stopped
    • upgrading
    private CommonCode cloudMssqlInstanceStatus; Cloud DB for MSSQLインスタンスの状態コード
    • INIT (initiate)
    • CREAT (created)
    • DEL (deleted)
    private CommonCode cloudMssqlInstanceOperation; Cloud DB for MSSQLインスタンスの Operationコード
    • CREAT (create)
    • DEL (delete)
    • FO (failover)
    • NULL (no operation)
    • SETUP (setup)
    • UPGD (upgrade)
    • DWGD (downgrade)
    • BKP (backup)
    private String generationCode; サーバの世代
    private String cloudMssqlImageProductCode; Cloud DB for MSSQLイメージの商品コード
    private Boolean isHa; 高可用性の有無
    private Boolean isMultiZone; マルチゾーンの有無
    private CommonCode license; Cloud DB for MSSQLライセンス
    private Integer cloudMssqlPort; Cloud DB for MSSQLポート
    private Integer backupFileRetentionPeriod; バックアップファイルの保管期間
    private String backupTime; バックアップ時間
    private String configGroupNo; Cloud DB for MSSQL Config Group番号
    private String configGroupName; Cloud DB for MSSQL Config Group名
    private String engineVersion; Cloud DB for MSSQLエンジンバージョン
    private Date createDate; 作成日
    private String dbCollation; Cloud DB for MSSQLキャラクターセット
    private List<CloudMssqlServerInstance> cloudMssqlServerInstanceList; Cloud DB for MSSQLサーバインスタンスリスト
    private AccessControlGroupNoList accessControlGroupNoList; ACG番号リスト

  • CloudMssqlServerInstanceタイプ

    CloudMssqlServerInstance 説明
    private String cloudMssqlServerInstanceNo; Cloud DB for MSSQLサーバインスタンス番号
    private String cloudMssqlServerName; Cloud DB for MSSQLサーバ名
    private CommonCode cloudMssqlServerRole; Cloud DB for MSSQLサーバロール
    private String cloudMssqlServerInstanceStatusName; Cloud DB for MSSQLサーバインスタンスの状態名
    • creating
    • deleted
    • deleting
    • downgrading
    • pending
    • recovering
    • reinstalling
    • restarting
    • running
    • settingup
    • shuttingdown
    • stopped
    • upgrading
    • downgrading
    private CommonCode cloudMssqlServerInstanceStatus; Cloud DB for MSSQLサーバインスタンスの状態コード
    • DEL (deleted)
    • PEND (pending)
    • RUN (running)
    • STOP (stopped)
    • FSTOP (failure stopped)
    private CommonCode cloudMssqlServerInstanceOperation; Cloud DB for MSSQLサーバインスタンスの Operationコード
    • NOOP (no operation)
    • CREAT (create)
    • START (start)
    • RSTRT (restart)
    • SETUP (setup)
    • STOP (stop)
    • FO (failover)
    • DEL (delete)
    • UPGD (upgrade)
    • DWGD (downgrade)
    • RISTL (reinstall)
    private String regionCode; リージョンコード
    private String zoneCode; Zoneコード
    private String vpcNo; VPC番号
    private String subnetNo; Subnet番号
    private Long dataStorageSize; データストレージ容量
    private Integer cpuCount; CPU数
    private Long memorySize; メモリ容量
    private Boolean isPublicSubnet; Public Subnetかどうか
    private String cloudMssqlProductCode; Cloud DB for MSSQL商品コード
    private String privateDomain; プライベートドメイン名
    private String publicDomain; グローバルドメイン名
    private Date createDate; 作成日
    private Date uptime; VMの起動完了時間
    private CommonCode dataStorageType; データストレージタイプ
    private Long usedDataStorageSize; 使用中のデータストレージ容量

  • AccessControlGroupNoListタイプ

    AccessControlGroupNoList 説明
    private List<String> accessControlGroupNoList = new ArrayList<>(); ACG番号リスト

例

呼び出しとレスポンスの例を説明します。

呼び出し例

呼び出しのサンプルコードは次の通りです。

ncloud vmssql createCloudMssqlInstance --regionCode KR --vpcNo ****83 --subnetNo ****91 --mirrorSubnetNo ****92 --cloudMssqlServiceName test-**** --configGroupNo **9 --cloudMssqlImageProductCode SW.VMSSL.OS.WND64.WINNT.SVR2016.MSSQL.15020005.SE.B100 --cloudMssqlProductCode SVR.VMSSL.STAND.C002.M008.NET.HDD.B100.G002 --dataStorageTypeCode SSD --isHa true --isMultiZone true --backupFileRetentionPeriod 10 --backupTime 00:15 --isAutomaticBackup true --cloudMssqlUserName test**** --cloudMssqlUserPassword ******** --cloudMssqlPort 1433 --characterSetName Korean_Wansung_CI_AS --engineVersionCode 15.0.4355.3

レスポンス例

レスポンスのサンプルコードは次の通りです。

レスポンス結果の形式タイプ(output)が jsonの場合

レスポンス結果の形式タイプ(output)が jsonの場合は次の通りです。

{
  "createCloudMssqlInstanceResponse": {
    "requestId": "c04bfdd1-e27e-4006-9bc3-bc37840ce1dd",
    "returnCode": 0,
    "returnMessage": "success",
    "totalRows": 1,
    "cloudMssqlInstanceList": [
      {
        "cloudMssqlInstanceNo": "****890",
        "cloudMssqlServiceName": "test-****",
        "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.15020005.SE.B100",
        "isHa": true,
        "isMultiZone": true,
        "license": {
          "code": "GPL",
          "codeName": "General Public License"
        },
        "cloudMssqlPort": 1433,
        "backupFileRetentionPeriod": 10,
        "backupTime": "00:15",
        "configGroupNo": "**9",
        "configGroupName": "test-****-config",
        "engineVersion": "MSSQL 15.0.2000.5 Standard Edition",
        "createDate": "2021-04-12T19:30:38+0900",
        "cloudMssqlServerInstanceList": [
          {
            "cloudMssqlServerName": "test-****-001-e04",
            "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": "****83",
            "subnetNo": "****91",
            "dataStorageSize": 10737418240,
            "cpuCount": 2,
            "memorySize": 8589934592,
            "isPublicSubnet": true,
            "cloudMssqlProductCode": "SVR.VMSSL.STAND.C002.M008.NET.HDD.B100.G002",
            "createDate": "2021-05-27T19:00:00+0900",
            "dataStorageType": {
              "code": "SSD",
              "codeName": "SSD"
            }
          },
          {
            "cloudMssqlServerName": "test-****-001-e05",
            "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": "****83",
            "subnetNo": "****92",
            "dataStorageSize": 10737418240,
            "cpuCount": 2,
            "memorySize": 8589934592,
            "isPublicSubnet": true,
            "cloudMssqlProductCode": "SVR.VMSSL.STAND.C002.M008.NET.HDD.B100.G002",
            "createDate": "2021-05-27T19:00:00+0900",
            "dataStorageType": {
              "code": "SSD",
              "codeName": "SSD"
            }
          }
        ]
      }
    ]
  }
}

レスポンス結果の形式タイプ(responseFormatType)が xmlの場合

レスポンス結果の形式タイプ(responseFormatType)が xmlの場合は次の通りです。

<createCloudMssqlInstanceResponse>
    <requestId>c04bfdd1-e27e-4006-9bc3-bc37840ce1dd</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>1</totalRows>
    <cloudMssqlInstanceList>
        <cloudMssqlInstance>
            <cloudMssqlInstanceNo>****890</cloudMssqlInstanceNo>
            <cloudMssqlServiceName>test-****</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>
            <generationCode>G2</generationCode>
            <cloudMssqlImageProductCode>SW.VMSSL.OS.WND64.WINNT.SVR2016.MSSQL.15020005.SE.B100</cloudMssqlImageProductCode>
            <isHa>true</isHa>
            <isMultiZone>true</isMultiZone>
            <license>
                <code>GPL</code>
                <codeName>General Public License</codeName>
            </license>
            <cloudMssqlPort>1433</cloudMssqlPort>
            <backupFileRetentionPeriod>10</backupFileRetentionPeriod>
            <backupTime>00:15</backupTime>
            <configGroupNo>**9</configGroupNo>
            <configGroupName>test-****-config</configGroupName>
            <engineVersion>MSSQL 15.0.2000.5 Standard Edition</engineVersion>
            <createDate>2021-04-12T19:30:38+0900</createDate>
            <cloudMssqlServerInstanceList>
                <cloudMssqlServerInstance>
                    <cloudMssqlServerName>test-****-001-e04</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>****83</vpcNo>
                    <subnetNo>****91</subnetNo>
                    <dataStorageSize>10737418240</dataStorageSize>
                    <cpuCount>2</cpuCount>
                    <memorySize>8589934592</memorySize>
                    <isPublicSubnet>true</isPublicSubnet>
                    <cloudMssqlProductCode>SVR.VMSSL.STAND.C002.M008.NET.HDD.B100.G002</cloudMssqlProductCode>
                    <createDate>2021-05-27T19:00:00+0900</createDate>
                    <dataStorageType>
                        <code>SSD</code>
                        <codeName>SSD</codeName>
                    </dataStorageType>
                </cloudMssqlServerInstance><cloudMssqlServerInstance>
                <cloudMssqlServerName>test-****-001-e05</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>****83</vpcNo>
                <subnetNo>****92</subnetNo>
                <dataStorageSize>10737418240</dataStorageSize>
                <cpuCount>2</cpuCount>
                <memorySize>8589934592</memorySize>
                <isPublicSubnet>true</isPublicSubnet>
                <cloudMssqlProductCode>SVR.VMSSL.STAND.C002.M008.NET.HDD.B100.G002</cloudMssqlProductCode>
                <createDate>2021-05-27T19:00:00+0900</createDate>
                <dataStorageType>
                    <code>SSD</code>
                    <codeName>SSD</codeName>
                </dataStorageType>
            </cloudMssqlServerInstance>
            </cloudMssqlServerInstanceList>
        </cloudMssqlInstance>
    </cloudMssqlInstanceList>
</createCloudMssqlInstanceResponse>