createCloudMssqlInstance

印刷する
共有
PDF

Article Summary

Share feedback

Thanks for sharing your feedback!

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] [output]

パラメータ

パラメータについての説明は、次のとおりです。

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

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

レスポンス例

レスポンス例は、次のとおりです。

レスポンス結果フォーマットタイプ(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"
        },
        "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>
            <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>

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

What's Next

createCloudMssqlSlaveInstance

コマンド
レスポンス
例

タグ