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

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

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 ブロックを追加できます。以下のフォーマットがサポートされています。

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

• CIDR 形式 (例: 10.10.XX.XX/24)。Classless Inter-Domain Routing を示し、24 はアドレスのプレフィックス長を表します。有効値は 1～32 です。

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

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

• Postpaid: 従量課金。

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

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

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

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

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

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

• RDS Cluster Edition インスタンスの場合、2 ノードクラスターでは ZoneIdSlave1 が必要であり、3 ノードクラスターでは ZoneIdSlave1 と ZoneIdSlave2 の両方が必要です。

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

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

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

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

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

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

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

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

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

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

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

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

VPC の ID。

vSwitch の ID。

インスタンスの内部 IP アドレス。IP アドレスは、指定された vSwitch のアドレス範囲内である必要があります。デフォルトでは、システムは 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 も指定する必要があります。

キー ID は Key Management Service コンソールで確認するか、新しいキーを作成できます。詳細については、「キーの作成」を参照してください。

RDS サービスアカウントに KMS へのアクセス権限を付与する RAM ロールの Alibaba リソースネーム (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 Edition インスタンスを作成する場合に必須です。たとえば、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。

専用クラスターに RDS インスタンスを作成する場合に必須です。

• DescribeDedicatedHostGroups オペレーションを呼び出して、RDS ホストグループ情報を照会します。

• RDS ホストグループを作成していない場合は、CreateDedicatedHostGroup オペレーションを呼び出して作成します。

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

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

• DescribeDedicatedHosts を呼び出して、RDS ホストグループ内のホスト情報を照会します。

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

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

専用クラスターで RDS 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 タイムゾーンはサポートされていません。名前付きタイムゾーンの詳細については、「名前付きタイムゾーンリファレンス」を参照してください。

  • このパラメーターは、インスタンスがクラウドディスクを使用している場合にのみ設定できます。

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

• 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 のみでサポートされています。有効な値:

• 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 (デフォルト): 原子性。同じバッチ内のすべてのインスタンスが正常に作成されるか、いずれかのインスタンスの作成に失敗した場合はすべて作成されません。

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

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

• true: 有効。

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

ApsaraDB RDS for PostgreSQL の Babelfish 設定。

設定フォーマット: {"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***) です。

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

• MySQL: 1000～65534

• PostgreSQL、SQL Server、MariaDB: 1000～5999

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

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

• true: 有効。

• false: 無効。

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

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

• false: 料金を請求せずに注文を生成します。

高性能 ESSD のバッファープール拡張 (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: 無効。