ApsaraDB RDS：CreateDBInstance

地域 ID。可呼叫 DescribeRegions 取得。

資料庫類型。取值：

• MySQL

• SQLServer

• PostgreSQL

• MariaDB。

資料庫版本。取值：

• 常規執行個體

  • MySQL：5.5、5.6、5.7、8.0

  • SQL Server：08r2_ent_ha（雲端硬碟版，已停售）、2008r2（高效能本機磁碟，已停售）、2012（企業版單機）、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

• 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

執行個體規格。可以指定標準版或倚天版規格，詳情請參見主執行個體規格表。

如需建立 Serverless 執行個體，請傳入如下取值：

• 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 GB 進行遞增，取值範圍請參見執行個體規格表。

棄用參數，無需配置。

執行個體的網路連線類型。固定配置 Intranet，表示內網連線。

執行個體名稱。長度為 2~255 個字元。以中文、英文字母開頭，可以包含數字、中文、英文、短橫線（-）。

該執行個體的 IP 白名單。多條記錄請以半形逗號（,）隔開，不可重複，單個執行個體最多新增 1000 個 IP 位址或 IP 段。支援如下兩種格式：

• IP 位址形式，例如：10.10.XX.XX。

• CIDR 形式，例如：10.10.XX.XX/24（無類別域間路由，24 表示了位址中前綴的長度，範圍為 1~32）。

用於保證請求的冪等性，防止重複提交請求。由用戶端產生該參數值，要保證在不同請求間唯一，最大值不超過 64 個 ASCII 字元，且該參數值中不能包含非 ASCII 字元。

執行個體的付費類型，取值：

• Postpaid：後付費（隨用隨付）。

• Prepaid：預付費（包年包月）。

• Serverless：Serverless 付費類型，不支援 MariaDB 執行個體。更多資訊，請參見 MySQL Serverless 執行個體簡介、SQL Server Serverless 執行個體簡介、PostgreSQL Serverless 執行個體簡介。

主節點可用區 ID。

• 指定了 VPC 和交換機時，此處必須傳入目標交換機所在的可用區 ID，否則無法建立成功。

• 對於高可用系列執行個體，還需傳入 ZoneIdSlave1，以此決定執行個體是單可用區部署還是多可用區部署。

• 對於三節點企業系列執行個體，還需傳入 ZoneIdSlave1 和 ZoneIdSlave2，以此決定執行個體是單可用區部署還是多可用區部署。

• 對於 RDS 叢集系列執行個體，兩節點還需要傳入 ZoneIdSlave1，三節點還需要傳入 ZoneIdSlave1 和 ZoneIdSlave2。

備節點可用區 ID。

• 如果填寫 Auto，則表示多可用區部署並且會自動為備節點選擇可用區。

• 如果和 ZoneId 相同，則為單可用區部署。

• 如果和 ZoneId 不同，則為多可用區部署。

RDS MySQL 叢集系列執行個體支援在新建執行個體時，同時建立 1~2 個備節點。有此需求時，您可透過本參數指定第 2 個備節點的可用區。

執行個體的網路類型。取值：

• VPC：專有網路。

• Classic：經典網路。

執行個體的存取模式。取值：

• Standard：標準存取模式。

• Safe：資料庫代理模式。

預設為 RDS 系統分配。

專有網路（VPC）ID。

虛擬交換機 ID。

• 可用區對應關係：VSwitchId 所在的可用區必須與主節點可用區（ZoneId）和備節點可用區（ZoneIdSlave1）相對應；且填寫了兩個交換機 ID 時，其順序需分別與 ZoneId 和 ZoneSlaveId1 的順序一致。

• 網路類型限制：網路類型 InstanceNetworkType 必須為 VPC。

• 多交換機填寫要求：若您填寫了 ZoneSlaveId1（備節點可用區 ID），並且不為 Auto，此處需填寫兩個交換機 ID，並使用半形逗號（,）隔開。

• 字元限制：VSwitchId 中不能包含空格、！、#、￥、&、%等特殊字元。

設定執行個體的內網 IP。需要在指定交換機的 IP 位址範圍內。系統預設透過 VPCId 和 vSwitchId 自動分配。

指定購買時長。取值：

• 當參數 Period=Year 時，UsedTime 取值為 1~5。

• 當參數 Period=Month 時，UsedTime 取值為 1~11。

指定預付費執行個體為包年或者包月類型。取值：

• Year：包年。

• Month：包月。

資源群組 ID。

執行個體儲存類型。取值：

• local_ssd：高效能本機磁碟（推薦）。

• general_essd：高效能雲端硬碟（推薦）。

• cloud_essd：ESSD PL1 雲端硬碟。

• cloud_essd2：ESSD PL2 雲端硬碟。

• cloud_essd3：ESSD PL3 雲端硬碟。

• cloud_ssd：SSD 雲端硬碟（不推薦，部分地域已經停止售賣）。

本參數的預設值根據 DBInstanceClass 參數中傳的規格代碼自動判斷：

• 規格代碼為高效能本機磁碟規格：預設值為 local_ssd。

• 規格代碼為雲端硬碟規格：預設值為 cloud_essd。

業務擴充參數。

同地域內的雲端硬碟加密的密鑰 ID。傳入此參數表示開啟雲端硬碟加密（開啟後無法關閉），並且需要傳入 RoleARN。

您可以在密鑰管理服務控制台查看密鑰 ID，也可以建立新的密鑰。詳情請參見建立密鑰。

主帳號授權 RDS 雲端服務帳號存取 KMS 權限的全域資源描述符（ARN）。您可以透過 CheckCloudResourceAuthorized 介面查看 ARN 資訊。

執行個體是否自動續費，僅在建立包年包月執行個體時傳入。取值：

• true

• false

執行個體系列。取值：

• 常規執行個體

  • Basic：基礎系列。

  • HighAvailability：高可用系列。

  • cluster：MySQL 或 PostgreSQL 叢集系列。

  • AlwaysOn：SQL Server 叢集系列。

  • Finance：三節點企業系列。

  說明

  建立 SQL Server 企業叢集版和基礎系列企業版時，該參數必填。例如：建立基礎系列的 2022 企業叢集版（2022_ent）時，該參數必須傳入 Basic。

• Serverless 執行個體

  • serverless_basic：Serverless 基礎系列。（僅適用 MySQL 和 PostgreSQL）

  • serverless_standard：Serverless 高可用系列。（僅適用 MySQL 和 PostgreSQL）

  • serverless_ha：SQL Server Serverless 高可用系列。

  說明

  當 PayType=Serverless 時，該參數必填。

專屬叢集主機群組 ID。

在專屬叢集內建立 RDS 執行個體時需要指定。

• 您可以呼叫 DescribeDedicatedHostGroups 介面查詢 RDS 主機群組資訊。

• 如您還未建立 RDS 主機群組，可以呼叫 CreateDedicatedHostGroup 介面建立。

專屬叢集中主執行個體的主機 ID。

在專屬叢集內建立 RDS 執行個體時需要指定。如不指定該參數，系統預設自動分配主機。

• 您可以呼叫 DescribeDedicatedHosts 介面查詢 RDS 主機群組內的主機資訊。

• 如您還沒有主機，可以呼叫 CreateDedicatedHost 介面新增。

專屬叢集中備執行個體的主機 ID。

在專屬叢集內建立 RDS 高可用系列或三節點企業系列執行個體時需要指定。如不指定該參數，系統預設自動分配主機。

• 您可以呼叫 DescribeDedicatedHosts 介面查詢 RDS 專屬叢集內的主機資訊。

• 如您還沒有主機，可以呼叫 CreateDedicatedHost 介面新增。

專屬叢集中日誌執行個體的主機 ID。

在專屬叢集內建立 RDS 三節點企業系列執行個體時需要指定。如不指定該參數，系統預設自動分配主機。

• 您可以呼叫 DescribeDedicatedHosts 介面查詢 RDS 專屬叢集內的主機資訊。

• 如您還沒有主機，可以呼叫 CreateDedicatedHost 介面新增。

參數範本 ID。可呼叫 DescribeParameterGroups 查詢。

設定執行個體的時區，僅在 Engine 為 MySQL 或 PostgreSQL 時生效。

• Engine 為 MySQL：

  • 此參數配置 UTC 時區。取值範圍為 -12:59 ~ +13:00。

  • 高效能本機磁碟執行個體可以使用命名時區，例如 Asia/Hong_Kong。命名時區的詳細資訊，請參見命名時區參考。

• Engine 為 PostgreSQL：

  • 此參數配置命名時區，不支援 UTC 時區。命名時區的詳細資訊，請參見命名時區參考。

  • 僅當執行個體為 PostgreSQL 雲端硬碟時，該參數可配置。

表名是否區分大小寫。取值：

• true：不區分大小寫（預設）。

• false：區分大小寫。

指定建立的 RDS 執行個體的核心小版本，僅在建立 MySQL 或 PostgreSQL 執行個體時需要傳入。 格式：

• MySQL：<執行個體版本>_<數字版本號>。例如 rds_20200229、xcluster_20200229 或 xcluster80_20200229。說明如下：

  • rds：高可用系列或基礎系列。

  • xcluster：MySQL 5.7 三節點企業系列。

  • xcluster80：MySQL 8.0 三節點企業系列。

  說明

  數字版本號可透過呼叫 DescribeDBMiniEngineVersions 介面查詢。各版本差異，請參見 AliSQL 小版本 Release Notes。

• PostgreSQL：rds_postgres_<大版本>00_<小版本號>。例如 rds_postgres_1400_20220830。說明如下：

  • 1400：PostgreSQL 大版本為 14。

  • 20220830：AliPG 核心小版本，可透過呼叫 DescribeDBMiniEngineVersions 介面查詢。各版本差異，請參見 PostgreSQL 小版本 Release Notes。

  說明

  如果 BabelfishConfig 中配置了啟用 Babelfish，則 RDS PostgreSQL 執行個體小版本格式為：rds_postgres_大版本 00_AliPG 核心小版本_babelfish。

儲存空間自動擴容開關，僅 MySQL 和 PostgreSQL 支援。取值：

• Enable：開啟。

• Disable：關閉（預設）。

儲存空間自動擴容觸發閾值（百分比）。取值：

• 10

• 20

• 30

• 40

• 50

儲存空間自動擴容的總儲存空間上限值，即自動擴容不會導致執行個體總儲存空間超過該值。單位：GB。

是否對本次建立執行個體的操作執行預檢查。取值：

• true：執行預檢查操作，不建立執行個體。檢查項目包含請求參數、請求格式、業務限制和庫存等。

• false：傳送正常請求，通過檢查後直接建立執行個體（預設）。

使用者備份 ID。可呼叫 ListUserBackupFiles 介面查詢。傳入該參數，可基於使用者備份建立執行個體。

如需傳入此參數，有如下限制：

• PayType 參數必須為 Postpaid。

• Engine 參數必須為 MySQL。

• EngineVersion 參數必須為 5.7。

• Category 參數必須為 Basic。

指定需要建立的 RDS MySQL 執行個體數量。本參數僅適用於批次建立 RDS MySQL 執行個體。

取值範圍：1~20；預設值：1。

批次建立執行個體策略。本參數僅在 Amount 參數大於 1 時生效，取值：

• Atomicity（預設值）：原子性。即同一批次的執行個體要麼全部建立成功，若有一個建立失敗，則所有執行個體建立失敗。

• Partial：非原子性。即執行個體的建立不受同一批次中其他執行個體的影響。

是否開啟 RDS 釋放保護功能，僅隨用隨付執行個體支援。取值：

• true：開啟。

• false：關閉（預設）。

Babelfish for RDS PostgreSQL 配置資訊。

配置格式：{"babelfishEnabled":"true","migrationMode":"xxxxxxx","masterUsername":"xxxxxxx","masterUserPassword":"xxxxxxxx"}

參數含義如下：

• babelfishEnabled：是否開啟 Babelfish，開啟為 true，該參數不配置預設不開啟。

• migrationMode：資料庫模式，單資料庫模式配置為 single-db，多資料庫模式配置為 multi-db。

• masterUsername：初始化管理帳號。由小寫字母、數字、底線組成，以字母開頭，以字母或數字結尾，最多 63 個字元，且不能以 pg 開頭。

• masterUserPassword：管理帳號的密碼。由大寫、小寫、數字、特殊字元組成，至少包含三種，長度為 8－32 位；特殊字元包括 ! @ # $ % ^ & * () _ + - =。

数据库内网连接地址。

连接地址格式：xxx.mysql.rds.aliyuncs.com，其中xxx是实例 ID 的前缀，如 rm-uf6wjk5***。

支持在创建 RDS 实例时初始化端口。取值范围：

• MySQL：1000~65534

• PostgreSQL、SQL Server、MariaDB：1000~5999

棄用參數，無需配置。

高性能云盘的 IO 性能突发功能开关。取值：

• true：开启。

• false：关闭。

是否自动支付。取值：

• true：自动支付。您需要确保账户余额充足。

• false：只生成订单不扣费。

高性能云盘的Buffer Pool Extension（BPE）功能开关。取值：

• 1：开启

• 0：不开启

高性能云盘数据归档功能开关。取值：

• true：开启。

• false：关闭。

白名单列表。 当需要配置多个 IP 地址时，用英文逗号隔开多个 IP 地址或 IP 段，且逗号前后不能有空格，例如192.168.0.1,172.16.213.9。

是否自动创建代理。取值：

• true：开启自动创建，默认为通用代理。

• false：不开启自动创建。

是否使用代金券。取值：

• true：使用代金券。

• false（默认）：不使用代金券。

优惠券 code。

16K 原子写功能开关。取值：

• optimized：开启。

• none（默认）：关闭。

开启或关闭RDS MySQL 原生复制。取值：

• ON：开启。

• OFF：关闭。