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 Basic)、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、2025_ent、2025_std

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

  • MariaDB: 10.3、10.6

• Serverless インスタンス

  • 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) のインスタンスタイプを指定できます。詳細については、「プライマリインスタンスタイプ」をご参照ください。

Serverless インスタンスを作成するには、以下のいずれかの値を指定します。

• MySQL Basic Edition: mysql.n2.serverless.1c

• MySQL High-availability Edition: mysql.n2.serverless.2c

• SQL Server: mssql.mem2.serverless.s2

• PostgreSQL Basic Edition: pg.n2.serverless.1c

• PostgreSQL High-availability Edition: pg.n2.serverless.2c

インスタンスストレージ容量。単位: GB。値は 5 GB 刻みで増加します。有効な値については、「プライマリインスタンスタイプ」をご参照ください。

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

インスタンスのネットワーク接続性タイプ。内部ネットワーク接続を指定する Intranet に値を設定します。

インスタンス名。名前の長さは 2～255 文字で、英数字、漢字、ハイフン (-) を含めることができます。先頭は英字または漢字である必要があります。

インスタンスの IP アドレスホワイトリスト。複数のエントリはコンマ (,) で区切ります。エントリを重複させることはできません。単一のインスタンスに対して最大 1,000 個の IP アドレスまたは CIDR ブロックを追加できます。以下の 2 つのフォーマットがサポートされています。

• IP アドレス形式 (例: 10.10.XX.XX)。

• CIDR 形式 (例: 10.10.XX.XX/24)。クラスレスドメイン間ルーティングであり、24 はプレフィックス長 (1～32) を示します。

リクエストのべき等性を確保するために使用されるクライアントトークン。クライアントを使用してトークンを生成できますが、異なるリクエスト間でトークンが一意であることを確認する必要があります。トークンには ASCII 文字のみを使用でき、長さは 64 文字以下である必要があります。

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

• Postpaid: 従量課金。

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

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

プライマリノードのゾーン ID。

• VPC と vSwitch を指定する場合、vSwitch のゾーン ID を指定する必要があります。指定しない場合、インスタンスを作成できません。

• High-availability Edition インスタンスの場合、ZoneIdSlave1 も指定して、インスタンスがシングルゾーン Deployment かマルチゾーン Deployment かを決定する必要があります。

• RDS Enterprise Edition インスタンスの場合、ZoneIdSlave1 および ZoneIdSlave2 も指定して、インスタンスがシングルゾーン Deployment かマルチゾーン Deployment かを決定する必要があります。

• RDS Cluster Edition インスタンスの場合、2 ノードクラスターの場合は ZoneIdSlave1 を、3 ノードクラスターの場合は ZoneIdSlave1 および ZoneIdSlave2 を指定する必要があります。

セカンダリノードのゾーン ID。

• このパラメーターを Auto に設定すると、システムがマルチゾーン Deployment のセカンダリノードのゾーンを自動的に選択します。

• このパラメーターが ZoneId と同じ値に設定されている場合、インスタンスはシングルゾーン Deployment を使用します。

• このパラメーターが ZoneId と異なる値に設定されている場合、インスタンスはマルチゾーン Deployment を使用します。

RDS MySQL Cluster Edition インスタンスでは、インスタンス作成時に 1 つまたは 2 つのセカンダリノードを作成できます。このパラメーターを使用して、2 番目のセカンダリノードのゾーン ID を指定できます。

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

• VPC: 仮想プライベートクラウド。

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

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

• Standard: 標準モード。

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

デフォルト値はシステムによって割り当てられます。

VPC の ID。

vSwitch の ID。

• ゾーンマッピング: vSwitch のゾーンは、プライマリノードのゾーン (ZoneId) およびセカンダリノードのゾーン (ZoneIdSlave1) に対応している必要があります。2 つの vSwitch ID を指定する場合、その順序は ZoneId と ZoneSlaveId1 の順序と一致している必要があります。

• ネットワークタイプの制限: InstanceNetworkType を VPC に設定する必要があります。

• 複数の vSwitch の要件: ZoneSlaveId1 (セカンダリノードのゾーン ID) を指定し、それが Auto に設定されていない場合、コンマ (,) で区切られた 2 つの vSwitch ID を指定する必要があります。

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

インスタンスの内部 IP アドレス。IP アドレスは、指定された vSwitch の IP アドレス範囲内である必要があります。システムは VPCId および vSwitchId の値に基づいて内部 IP アドレスを自動的に割り当てます。

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

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

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

サブスクリプション期間の単位。有効な値:

• Year

• Month

リソースグループの ID。

インスタンスストレージタイプ。有効な値:

• local_ssd: 高性能ローカル SSD (推奨)。

• general_essd: 高性能 ESSD (推奨)。

• cloud_essd: PL1 ESSD。

• cloud_essd2: PL2 ESSD。

• cloud_essd3: PL3 ESSD。

• cloud_ssd: 標準 SSD (非推奨、一部のリージョンでは販売終了)。

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

• インスタンスタイプが高性能ローカル SSD の場合、デフォルト値は local_ssd です。

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

ビジネス拡張パラメーター。

同じリージョン内のクラウドディスク暗号鍵の ID。このパラメーターを指定すると、クラウドディスク暗号化が有効になり、無効にすることはできません。RoleARN も指定する必要があります。

Key Management Service (KMS) コンソールでキー ID をビューするか、キーを作成できます。詳細については、「キーの作成」をご参照ください。

RDS クラウドサービスアカウントが KMS にアクセスできるように Alibaba Cloud アカウントの権限付与に使用されるグローバルリソース記述子 (Amazon リソースネーム (ARN))。CheckCloudResourceAuthorized 操作を呼び出して Amazon リソースネーム (ARN) をクエリできます。

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

• true

• false

インスタンスエディション。有効な値:

• 通常インスタンス

  • Basic: Basic Edition。

  • HighAvailability: High-availability Edition。

  • cluster: MySQL または PostgreSQL Cluster Edition。

  • AlwaysOn: SQL Server Cluster Edition。

  • Finance: RDS Enterprise Edition。

  説明

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

• Serverless インスタンス

  • 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 操作を呼び出して、RDS ホストグループ情報をクエリできます。

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

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

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

• DescribeDedicatedHosts 操作を呼び出して、RDS ホストグループ内のホスト情報をクエリできます。

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

専用クラスター内のセカンダリインスタンスのホスト ID。

専用クラスターに High-availability Edition または RDS Enterprise Edition インスタンスを作成する場合、このパラメーターは必須です。このパラメーターを指定しない場合、システムがデフォルトでホストを割り当てます。

• DescribeDedicatedHosts 操作を呼び出して、RDS 専用クラスター内のホスト情報をクエリできます。

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

専用クラスター内のログインスタンスのホスト ID。

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

• DescribeDedicatedHosts 操作を呼び出して、RDS 専用クラスター内のホスト情報をクエリできます。

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

パラメータテンプレートの ID。DescribeParameterGroups 操作を呼び出して、パラメータテンプレート ID をクエリできます。

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

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

  • このパラメーターは 協定世界時 (UTC) タイムゾーンを指定します。有効な値: -12:59 ～ +13:00。

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

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

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

  • このパラメーターは、クラウドディスクを使用する PostgreSQL インスタンスでのみ設定可能です。インスタンス作成後にパラメータ設定を変更できます。

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

• true: 大文字と小文字を区別しません (デフォルト)。

• false: 大文字と小文字を区別します。

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

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

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

  • xcluster: MySQL 5.7 RDS Enterprise Edition。

  • xcluster80: MySQL 8.0 RDS Enterprise Edition。

  説明

  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 となります。

自動ストレージ拡張を有効にするかどうかを指定します。このパラメーターは MySQL および 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 RDS PostgreSQL の構成。

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

パラメーターの説明:

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

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

• masterUsername: 初期管理者アカウント名。名前には小文字、数字、アンダースコア (_) を含めることができます。先頭は英字、末尾は英字または数字である必要があります。長さは最大 63 文字で、pg で始めることはできません。

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

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

エンドポイントのフォーマット: xxx.mysql.rds.aliyuncs.com。ここで xxx はインスタンス ID のプレフィックス (例: rm-uf6wjk5***) です。

ApsaraDB RDS インスタンス作成時に初期化するポート番号。有効な値:

• MySQL: 1000～65534

• PostgreSQL、SQL Server、MariaDB: 1000～5999

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

高性能 ESSD の I/O バースト特徴を有効にするかどうかを指定します。有効な値:

• true: 有効。

• false: 無効。

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

• true: 有効。アカウント残高が十分であることを確認してください。

• false: 料金を差し引かずに注文を生成します。

高性能 ESSD の Buffer Pool Extension (BPE) 特徴を有効にするかどうかを指定します。有効な値:

• 1: 有効。

• 0: 無効。

高性能 ESSD の コールドデータアーカイブ 特徴を有効にするかどうかを指定します。有効な値:

• true: 有効。

• false: 無効。

ホワイトリストテンプレートリスト。 複数の IP アドレスを指定するには、コンマ (,) で区切ります。コンマの前後にスペースを入れることはできません。例: 192.168.0.1,172.16.213.9。

データベースプロキシの自動作成を有効にするかどうかを指定します。有効な値:

• true: 有効。デフォルトで汎用データベースプロキシが作成されます。

• false: 無効。

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

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

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

クーポンコード。

16KB 原子書き込み 特徴を有効にするかどうかを指定します。有効な値:

• optimized: 有効。

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

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

• ON: 有効。

• OFF: 無効。