CreateDBInstance - 创建RDS实例

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

实例规格。可以指定标准版或倚天版规格，详情请参见主实例规格表。

如需创建 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：关闭。