ApsaraDB RDS:CreateDBInstance

リージョン ID。DescribeRegions 操作を呼び出して、リージョンの最新リストを照会できます。

データベースエンジン。有効値：

• MySQL

• SQLServer

• PostgreSQL

• MariaDB

データベースエンジンのバージョン。有効値：

• 通常インスタンス

  • MySQL：5.5、5.6、5.7、8.0

  • SQL Server：08r2_ent_ha (クラウドディスク、提供終了)、2008r2 (ローカル SSD、提供終了)、2012 (Enterprise Edition シングルノード)、2012_ent_ha、2012_std_ha、2012_web、2014_ent_ha、2014_std_ha、2016_ent_ha、2016_std_ha、2016_web、2017_ent、2017_std_ha、2017_web、2019_ent、2019_std_ha、2019_web、2022_ent、2022_std_ha、2022_web

  • PostgreSQL：10.0、11.0、12.0、13.0、14.0、15.0、16.0、17.0、18.0

  • MariaDB：10.3、10.6

• サーバーレスインスタンス

  • MySQL：5.7、8.0

  • SQL Server：2016_std_sl、2017_std_sl、2019_std_sl

  • PostgreSQL：14.0、15.0、16.0、17.0、18.0

インスタンスタイプ。標準または Yitian インスタンスタイプを指定できます。詳細については、「プライマリインスタンスタイプ」をご参照ください。

サーバーレスインスタンスを作成するには、次のいずれかの値を指定します：

• MySQL ベーシックファミリー：mysql.n2.serverless.1c

• MySQL 高可用性ファミリー：mysql.n2.serverless.2c

• SQL Server：mssql.mem2.serverless.s2

• PostgreSQL ベーシックファミリー：pg.n2.serverless.1c

• PostgreSQL 高可用性ファミリー：pg.n2.serverless.2c

インスタンスのストレージ容量 (GB)。値は 5 の倍数である必要があります。値の範囲の詳細については、「プライマリインスタンスタイプ」をご参照ください。

このパラメーターは非推奨です。このパラメーターを設定する必要はありません。

インスタンスのネットワーク接続タイプ。内部接続の場合は、値を Intranet に設定します。

インスタンスの説明。長さは 2～255 文字で、文字または漢字で始まり、文字、数字、アンダースコア (_)、ハイフン (-) を含める必要があります。

インスタンスの IP ホワイトリスト。複数の IP アドレスまたは CIDR ブロックはカンマで区切ります。最大 1,000 個の一意の IP アドレスまたは CIDR ブロックを追加できます。以下の形式がサポートされています：

• IP アドレス (例：10.10.XX.XX)。

• CIDR ブロック (例：10.10.XX.XX/24)。スラッシュ (/) の後の数字 (24) はプレフィックス長を示します。有効値：1～32。

リクエストのべき等性を保証するためのクライアント生成トークン。トークンはグローバルに一意で、ASCII 文字のみで構成され、長さは 64 文字以下である必要があります。

インスタンスの課金方法。有効値：

• Postpaid：従量課金。

• Prepaid：サブスクリプション。

• Serverless：サーバーレス課金方法。この課金方法は MariaDB インスタンスではサポートされていません。詳細については、「サーバーレス ApsaraDB RDS for MySQL インスタンスの概要」、「サーバーレス ApsaraDB RDS for SQL Server インスタンスの概要」、および「サーバーレス ApsaraDB RDS for PostgreSQL インスタンスの概要」をご参照ください。

プライマリインスタンスのアベイラビリティゾーン ID。

• VPC と VSwitch を指定する場合、このパラメーターを VSwitch が配置されているアベイラビリティゾーンの ID に設定する必要があります。そうしないと、インスタンスは作成できません。

• High-availability Edition のインスタンスの場合、ZoneIdSlave1 パラメーターも指定して、インスタンスが単一アベイラビリティゾーンにデプロイされるか、複数アベイラビリティゾーンにまたがってデプロイされるかを決定する必要があります。

• 3 ノード Enterprise Edition のインスタンスの場合、ZoneIdSlave1 と ZoneIdSlave2 パラメーターも指定して、インスタンスが単一アベイラビリティゾーンにデプロイされるか、複数アベイラビリティゾーンにまたがってデプロイされるかを決定する必要があります。

• 2 ノード Cluster Edition のインスタンスの場合、ZoneIdSlave1 パラメーターも指定する必要があります。3 ノード Cluster Edition のインスタンスの場合、ZoneIdSlave1 と ZoneIdSlave2 パラメーターも指定する必要があります。

セカンダリインスタンスのアベイラビリティゾーン ID。

• このパラメーターを Auto に設定すると、インスタンスは複数アベイラビリティゾーンにまたがってデプロイされ、システムはセカンダリノードのアベイラビリティゾーンを自動的に選択します。

• この値が ZoneId パラメーターの値と一致する場合、インスタンスは単一アベイラビリティゾーンにデプロイされます。

• このパラメーターの値が ZoneId パラメーターの値と異なる場合、インスタンスは複数アベイラビリティゾーンにまたがってデプロイされます。

MySQL Cluster Edition インスタンスを作成する際、1つまたは2つのセカンダリインスタンスを作成できます。このパラメーターを使用して、2番目のセカンダリインスタンスのアベイラビリティゾーンを指定します。

インスタンスのネットワークタイプ。有効値：

• VPC：VPC。

• Classic：クラシックネットワーク。

インスタンスのアクセスモード。有効値：

• Standard：標準アクセスモード。

• Safe：データベースプロキシモード。

デフォルトでは、システムは接続モードを自動的に割り当てます。

VPC の ID。

VSwitch の ID。

• アベイラビリティゾーンマッピング：VSwitch のアベイラビリティゾーンは、プライマリインスタンス (ZoneId) とセカンダリインスタンス (ZoneIdSlave1) のアベイラビリティゾーンと同じである必要があります。2つの VSwitch ID を指定する場合、その順序は ZoneId と ZoneIdSlave1 の値の順序に対応する必要があります。

• ネットワークタイプの制限：InstanceNetworkType パラメーターは VPC に設定する必要があります。

• 複数の VSwitch の要件：ZoneIdSlave1 (セカンダリアベイラビリティゾーンの ID) を指定し、その値が Auto でない場合、カンマ (,) で区切られた2つの VSwitch ID を指定する必要があります。

• 文字の制限：VSwitchId には、スペース、!、#、$、&、% などの特殊文字を含めることはできません。

インスタンスのプライベート IP アドレス。IP アドレスは、指定された VSwitch の CIDR ブロック内にある必要があります。デフォルトでは、システムは VPCId および VSwitchId パラメーターに基づいてプライベート IP アドレスを自動的に割り当てます。

サブスクリプション期間。有効値：

• Period が Year に設定されている場合、UsedTime の有効値は 1～5 です。

• Period が Month に設定されている場合、UsedTime の有効値は 1～11 です。

サブスクリプションインスタンスのサブスクリプション期間の単位。有効値：

• Year

• Month

リソースグループの ID。

インスタンスのストレージタイプ。有効値：

• local_ssd：ローカル SSD (推奨)。

• general_essd：汎用 ESSD (推奨)。

• cloud_essd：ESSD PL1。

• cloud_essd2：ESSD PL2。

• cloud_essd3：ESSD PL3。

• cloud_ssd：標準 SSD (非推奨、一部のリージョンで提供終了)。

このパラメーターのデフォルト値は、DBInstanceClass パラメーターで指定されたインスタンスタイプによって決まります：

• インスタンスタイプがローカル SSD を使用する場合、デフォルト値は local_ssd です。

• インスタンスタイプがクラウドディスクを使用する場合、デフォルト値は cloud_essd です。

拡張ビジネス情報。

同じリージョンでディスク暗号化に使用されるカスタマーマスターキー (CMK) の ID。このパラメーターを指定すると、ディスク暗号化が有効になります。一度有効にすると、ディスク暗号化は無効にできません。RoleARN パラメーターも指定する必要があります。

キー ID は KMS コンソールで表示するか、CreateKey 操作を呼び出して CMK を作成できます。

ApsaraDB RDS サービスアカウントが KMS にアクセスするために引き受ける RAM ロールの Alibaba Cloud リソースネーム (ARN)。CheckCloudResourceAuthorized 操作を呼び出して ARN を照会できます。

サブスクリプションインスタンスの自動更新を有効にするかどうかを指定します。このパラメーターはサブスクリプションインスタンスに対してのみ有効です。有効値：

• true

• false

インスタンスファミリー。有効値：

• 通常インスタンス

  • Basic：Basic Edition。

  • HighAvailability：High-availability Edition。

  • cluster：MySQL または PostgreSQL Cluster Edition。

  • AlwaysOn：SQL Server Cluster Edition。

  • Finance：3 ノード Enterprise Edition。

  説明

  このパラメーターは、SQL Server インスタンスの Enterprise Cluster Editionまたはエンタープライズアーキテクチャの Basic Edition を作成する際に必須です。例えば、2022 Enterprise Cluster Edition (2022_ent) の Basic Edition インスタンスを作成する場合、このパラメーターを Basic に設定する必要があります。

• サーバーレスインスタンス

  • serverless_basic：Serverless Basic Edition (MySQL および PostgreSQL のみ)。

  • serverless_standard：Serverless High-availability Edition (MySQL および PostgreSQL のみ)。

  • serverless_ha：SQL Server Serverless High-availability Edition。

  説明

  このパラメーターは、PayType パラメーターが Serverless に設定されている場合に必須です。

専用ホストグループの ID。

このパラメーターは、専用ホストグループに ApsaraDB RDS インスタンスを作成する際に必須です。

• DescribeDedicatedHostGroups 操作を呼び出して、専用ホストグループの情報を照会できます。

• 専用ホストグループを作成していない場合は、CreateDedicatedHostGroup 操作を呼び出して作成できます。

専用ホストグループ内のプライマリインスタンスのホスト ID。

このパラメーターは、専用ホストグループに ApsaraDB RDS インスタンスを作成する際に必須です。このパラメーターを指定しない場合、システムは自動的にホストを割り当てます。

• DescribeDedicatedHosts 操作を呼び出して、専用ホストグループ内のホストの情報を照会できます。

• ホストがない場合は、CreateDedicatedHost 操作を呼び出して追加できます。

専用ホストグループ内のセカンダリインスタンスのホスト ID。

このパラメーターは、専用ホストグループに High-availability または 3 ノード Enterprise Edition の ApsaraDB RDS インスタンスを作成する際に必須です。このパラメーターを指定しない場合、システムは自動的にホストを割り当てます。

• DescribeDedicatedHosts 操作を呼び出して、専用ホストグループ内のホストの情報を照会できます。

• ホストがない場合は、CreateDedicatedHost 操作を呼び出して追加できます。

専用ホストグループ内のロガーインスタンスのホスト ID。

このパラメーターは、専用ホストグループに 3 ノード Enterprise Edition の ApsaraDB RDS インスタンスを作成する際に必須です。このパラメーターを指定しない場合、システムは自動的にホストを割り当てます。

• DescribeDedicatedHosts 操作を呼び出して、専用ホストグループ内のホストの情報を照会できます。

• ホストがない場合は、CreateDedicatedHost 操作を呼び出して追加できます。

パラメーターグループの ID。DescribeParameterGroups 操作を呼び出して ID を照会できます。

インスタンスのタイムゾーン。このパラメーターは、Engine が MySQL または PostgreSQL に設定されている場合にのみ有効です。

• Engine が MySQL に設定されている場合：

  • このパラメーターは UTC タイムゾーンを指定します。値は -12:59 から +13:00 の範囲内である必要があります。

  • ローカル SSD を使用するインスタンスは、Asia/Hong_Kong などの名前付きタイムゾーンを使用できます。名前付きタイムゾーンの詳細については、「名前付きタイムゾーンリファレンス」をご参照ください。

• Engine が PostgreSQL に設定されている場合：

  • このパラメーターは名前付きタイムゾーンを指定します。UTC タイムゾーンはサポートされていません。名前付きタイムゾーンの詳細については、「名前付きタイムゾーンリファレンス」をご参照ください。

  • このパラメーターは、クラウドディスクを使用する ApsaraDB RDS for PostgreSQL インスタンスでのみ設定できます。

テーブル名で大文字と小文字を区別するかどうかを指定します。有効値：

• true：大文字と小文字を区別しない (デフォルト)。

• false：大文字と小文字を区別する。

作成するインスタンスのマイナーエンジンバージョン。このパラメーターは、ApsaraDB RDS for MySQL または ApsaraDB RDS for PostgreSQL インスタンスを作成する場合にのみ必要です。 フォーマット：

• MySQL：<インスタンスバージョン>_<デジタルバージョン番号>。例：rds_20200229、xcluster_20200229、または xcluster80_20200229。説明：

  • rds：High-availability または Basic Edition。

  • xcluster：MySQL 5.7 Enterprise Edition (3ノード)。

  • xcluster80：MySQL 8.0 Enterprise Edition (3ノード)。

  説明

  DescribeDBMiniEngineVersions 操作を呼び出して、デジタルバージョン番号を照会できます。バージョンの違いの詳細については、「AliSQL リリースノート」をご参照ください。

• PostgreSQL：rds_postgres_<メジャーバージョン>00_<マイナーバージョン番号>。例：rds_postgres_1400_20220830。説明：

  • 1400：PostgreSQL のメジャーバージョンは 14 です。

  • 20220830：AliPG のマイナーエンジンバージョン。DescribeDBMiniEngineVersions 操作を呼び出して、マイナーエンジンバージョンを照会できます。バージョンの違いの詳細については、「PostgreSQL リリースノート」をご参照ください。

  説明

  BabelfishConfig で Babelfish が有効になっている場合、ApsaraDB RDS for PostgreSQL インスタンスのマイナーバージョンは次の形式になります：rds_postgres_<メジャーバージョン>00_<AliPG マイナーエンジンバージョン>_babelfish。

ストレージ自動スケーリングを有効にするかどうかを指定します。この機能は、ApsaraDB RDS for MySQL および ApsaraDB RDS for PostgreSQL でのみサポートされています。有効値：

• Enable：ストレージ自動スケーリングを有効にします。

• Disable：ストレージ自動スケーリングを無効にします (デフォルト)。

ストレージ自動スケーリングをトリガーするストレージ使用率。有効値：

• 10

• 20

• 30

• 40

• 50

インスタンスが自動的にスケーリングできる最大ストレージ容量 (GB)。

ドライランを実行するかどうかを指定します。有効値：

• true：ドライランを実行しますが、インスタンスは作成しません。システムはリクエストパラメーター、リクエスト形式、ビジネス上の制限、および利用可能なリソースをチェックします。

• false：通常のリクエストを送信します。リクエストがチェックを通過した場合、インスタンスが作成されます。これがデフォルト値です。

ユーザーバックアップの ID。ListUserBackupFiles 操作を呼び出して、ユーザーバックアップ ID を照会できます。このパラメーターを指定して、ユーザーバックアップからインスタンスを作成できます。

このパラメーターを指定する場合、以下の制限が適用されます：

• PayType パラメーターは Postpaid に設定する必要があります。

• Engine パラメーターは MySQL に設定する必要があります。

• EngineVersion パラメーターは 5.7 に設定する必要があります。

• Category パラメーターは Basic に設定する必要があります。

作成する ApsaraDB RDS for MySQL インスタンスの数。このパラメーターは、ApsaraDB RDS for MySQL インスタンスの一括作成にのみ適用されます。

有効値：1～20。デフォルト値：1。

一括インスタンス作成の作成ポリシー。このパラメーターは、Amount パラメーターが 1 より大きい値に設定されている場合にのみ有効です。有効値：

• Atomicity (デフォルト)：同じバッチ内のすべてのインスタンスが作成されるか、1つでも失敗した場合はどのインスタンスも作成されません。

• Partial：あるインスタンスの作成は、同じバッチ内の他のインスタンスの影響を受けません。

インスタンスの削除保護を有効にするかどうかを指定します。この機能は、従量課金インスタンスでのみサポートされています。有効値：

• true：削除保護を有効にします。

• false：削除保護を無効にします (デフォルト)。

Babelfish for ApsaraDB RDS for PostgreSQL の構成情報。

フォーマット：{"babelfishEnabled":"true","migrationMode":"xxxxxxx","masterUsername":"xxxxxxx","masterUserPassword":"xxxxxxxx"}

パラメーターの説明：

• babelfishEnabled：Babelfish を有効にするかどうかを指定します。値を true に設定して Babelfish を有効にします。このパラメーターを指定しない場合、Babelfish はデフォルトで無効になります。

• migrationMode：データベースモード。シングルデータベースモードの場合は single-db、マルチデータベースモードの場合は multi-db に値を設定します。

• masterUsername：管理者アカウント。アカウント名は小文字、数字、アンダースコア (_) で構成され、文字で始まり、文字または数字で終わり、長さは 63 文字以下で、pg で始まってはいけません。

• masterUserPassword：管理者アカウントのパスワード。パスワードは 8～32 文字の長さで、大文字、小文字、数字、特殊文字の少なくとも3種類を含む必要があります。特殊文字には ! @ # $ % ^ & * () _ + - = が含まれます。

インスタンスの内部エンドポイント。

エンドポイントの形式は xxx.mysql.rds.aliyuncs.com で、xxx はインスタンス ID のプレフィックスです (例：rm-uf6wjk5***)。

インスタンス作成時に初期化できるポート。有効範囲：

• MySQL：1000～65534

• PostgreSQL、SQL Server、MariaDB：1000～5999

このパラメーターは非推奨です。構成は不要です。

汎用 ESSD の I/O バースト機能を有効にするかどうかを指定します。 有効な値：

• true：機能を有効にします。

• false：機能を無効にします。

自動支払いを有効にするかどうかを指定します。 有効な値：

• true：自動支払いを有効にします。 アカウントに十分な残高があることを確認してください。

• false：注文は生成されますが、支払いは完了しません。

汎用 ESSD の バッファプール拡張 (BPE) 機能を有効にするかどうかを指定します。有効値：

• 1：機能を有効にします。

• 0：機能を無効にします。

汎用 ESSD のデータアーカイブ機能を有効にするかどうかを指定します。有効な値：

• true：機能を有効にします。

• false：機能を無効にします。

IP ホワイトリストのテンプレートです。複数の IP アドレスを指定する場合は、カンマ (,) で区切ります。カンマの前後にスペースは入れないでください。例：192.168.0.1,172.16.213.9。

データベースプロキシを自動的に作成するかどうかを指定します。有効な値は次のとおりです：

• true： プロキシの自動作成を有効にします。デフォルトでは、汎用プロキシが作成されます。

• false： プロキシの自動作成を無効にします。

クーポンを使用するかどうかを指定します。有効な値：

• true：クーポンを使用します。

• false：クーポンを使用しません (デフォルト)。

プロモーションコード。

16 KB アトミック書き込み機能を有効にするかどうかを指定します。 有効な値：

• optimized：有効。

• none (デフォルト)：無効。

RDS MySQL ネイティブレプリケーションを有効にするかどうかを指定します。有効な値：

• ON：有効。

• OFF：無効。