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、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

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

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

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

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

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

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

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

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

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

• Postpaid: 従量課金。

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

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

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

• VPC および vSwitch を指定する場合、このパラメーターには指定した vSwitch のゾーン ID を設定する必要があります。設定しない場合、インスタンスを作成できません。

• 高可用性シリーズのインスタンスの場合、ZoneIdSlave1 も指定して、インスタンスをシングルゾーンにデプロイするか、マルチゾーンにデプロイするかを決定する必要があります。

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

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

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

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

• このパラメーターを ZoneId と同じ値に設定すると、シングルゾーンデプロイメントが使用されます。

• このパラメーターを ZoneId と異なる値に設定すると、マルチゾーンデプロイメントが使用されます。

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

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

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

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

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

仮想プライベートクラウド (VPC) の ID。

vSwitch の ID。

インスタンスの内部ネットワーク IP アドレスの設定項目。IP アドレスは、指定された vSwitch のアドレス範囲内である必要があります。デフォルトでは、システムは VPCId および vSwitchId の値に基づいて内部ネットワーク IP アドレスを自動的に割り当てます。

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

サブスクリプションインスタンスの課金サイクルを年単位または月単位で指定するかどうかを指定します。有効な値:

• 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 です。

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

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

RDS サービスアカウントが Key Management Service (KMS) にアクセスするための権限付与を提供するグローバルリソース記述子 (ARN)。CheckCloudResourceAuthorized 操作を呼び出して 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 Enterprise インスタンスを作成する場合に必須です。たとえば、Basic Edition 2022 Enterprise Cluster Edition (2022_ent) インスタンスを作成する場合、このパラメーターを 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。

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

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

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

パラメータテンプレートの ID。DescribeParameterGroups を呼び出してパラメータテンプレートを照会できます。

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

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

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

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

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

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

  • このパラメーターは、クラウドディスクを搭載した PostgreSQL インスタンスに対してのみ設定できます。

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

• true: 大文字と小文字を区別しません。これがデフォルト値です。

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

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 が有効になっている場合、RDS PostgreSQL インスタンスのマイナーエンジンバージョンのフォーマットは rds_postgres_<メジャーバージョン>00_<AliPG マイナーエンジンバージョン>_babelfish となります。

ストレージの自動拡張を有効にするかどうかを指定します。このパラメーターは MySQL および PostgreSQL のみでサポートされています。有効な値:

自動ストレージ拡張をトリガーするしきい値 (パーセンテージ)。有効な値:

自動ストレージ拡張における合計ストレージ容量の上限。自動拡張によってインスタンスの合計ストレージ容量がこの値を超えることはありません。単位: GB。

このリクエストに対してドライランを実行するかどうかを指定します。有効な値:

ユーザーバックアップの ID。ListUserBackupFiles 操作を呼び出してユーザーバックアップ ID をクエリできます。このパラメーターを指定すると、ユーザーバックアップに基づいてインスタンスが作成されます。

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

インスタンスの一括作成時のストラテジー。このパラメーターは、Amount の値が 1 より大きい場合にのみ有効です。有効な値:

• Atomicity (デフォルト): 原子性。同じバッチ内のすべてのインスタンスがすべて正常に作成されるか、またはすべて失敗します。1 つのインスタンスの作成に失敗した場合、すべてのインスタンスが失敗します。

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

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

• true: 有効。

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

RDS PostgreSQL 用 Babelfish の構成情報。

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

RDS インスタンスの作成時に初期化するポート番号を指定します。有効な値:

• MySQL: 1000～65534

• PostgreSQL、SQL Server、MariaDB: 1000～5999

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

高性能パフォーマンスディスクの I/O バースト機能を有効にするかどうかを指定します。有効な値:

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

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

• false: 注文のみが生成され、支払いは行われません。

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

• 1: 有効。

• 0: 無効。

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

• true: 有効。

• false: 無効。

ホワイトリストテンプレート。

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

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

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

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

クーポンコード。

16KB アトミックライト 機能を有効にするかどうかを指定します。有効な値:

• optimized: 有効。

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

ApsaraDB RDS for MySQL のネイティブレプリケーションを有効または無効にします。有効な値:

• ON: 有効。

• OFF: 無効。