创建RDS实例

系统规定参数，取值：CreateDBInstance。

地域ID。可以通过接口DescribeRegions查看可用的地域ID。

数据库类型，取值：

• MySQL
• SQLServer
• PostgreSQL
• MariaDB

数据库版本，取值：

• MySQL：5.5、5.6、5.7、8.0
• SQL Server：2008r2、08r2_ent_ha、2012、2012_ent_ha、2012_std_ha、2012_web、2014_std_ha、2016_ent_ha、2016_std_ha、2016_web、2017_std_ha、2017_ent、2019_std_ha、2019_ent
• PostgreSQL：10.0、11.0、12.0、13.0、14.0、15.0
• MariaDB：10.3

实例规格。详情请参见主实例规格表。您也可以调用DescribeAvailableResource接口查询目标地域中可用的实例规格列表。

实例存储空间。单位：GB。每5GB进行递增，取值范围请参见实例规格表。您也可以调用DescribeAvailableResource接口查询目标实例规格中可用的存储空间范围。

字符集。该参数已弃用。

实例的网络连接类型，取值：

• Internet：公网连接。
• Intranet：内网连接。

实例名称。长度为2~255个字符。以中文、英文字母开头，可以包含数字、中文、英文、下划线（_）、短横线（-）。

该实例的IP白名单。多条记录请以半角逗号（,）隔开，不可重复，最多1000条记录。支持如下两种格式：

• IP地址形式，例如：10.10.XX.XX。
• CIDR形式，例如：10.10.XX.XX/24（无类域间路由，24表示了地址中前缀的长度，范围为1~32）。

用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，要保证在不同请求间唯一，最大值不超过64个ASCII字符，且该参数值中不能包含非ASCII字符。

实例的付费类型，取值：

• Postpaid：后付费（按量付费）。
• Prepaid：预付费（包年包月）。
• Serverless：Serverless付费类型，仅支持MySQL实例。更多信息，请参见MySQL Serverless实例简介。

主节点可用区ID。

备节点可用区ID。如果和ZoneId相同，则为单可用区部署；如果和ZoneId不同，则为多可用区部署。

备节点或日志节点可用区ID。如果和ZoneId相同，则为单可用区部署；如果和ZoneId不同，则为多可用区部署。

实例的网络类型，取值：

• VPC：专有网络。
• Classic：经典网络（默认）。

实例的访问模式，取值：

• Standard：标准访问模式。
• Safe：数据库代理模式。

默认为RDS系统分配。

专有网络（VPC） ID。

虚拟交换机（vSwitch） ID。虚拟交换机所在的可用区必须和ZoneId中传入的可用区ID相对应。

设置实例的内网IP。需要在指定交换机的IP地址范围内。系统默认通过VPCId和vSwitchId自动分配。

指定购买时长，取值：

• 当参数Period=Year时，UsedTime取值为1~5。
• 当参数Period=Month时，UsedTime取值为1~11。

指定预付费实例为包年或者包月类型，取值：

• Year：包年。
• Month：包月。

资源组ID。

实例存储类型，取值：

• local_ssd：本地SSD盘（推荐）。
• cloud_ssd：SSD云盘（不推荐，部分地域已经停止售卖）。
• cloud_essd：ESSD PL1云盘。
• cloud_essd2：ESSD PL2云盘。
• cloud_essd3：ESSD PL3云盘。

• 规格代码为本地盘规格：默认值为local_ssd。
• 规格代码为云盘规格：默认值为cloud_essd。

业务扩展参数。

同地域内的云盘加密的密钥ID。传入此参数表示开启云盘加密（开启后无法关闭），并且需要传入RoleARN。

您可以在密钥管理服务控制台查看密钥ID，也可以创建新的密钥。详情请参见创建密钥。

主账号授权RDS云服务账号访问KMS权限的全局资源描述符（ARN）。您可以通过CheckCloudResourceAuthorized接口查看ARN信息。

实例是否自动续费，仅在创建包年包月实例时传入，取值：

• true
• false

实例系列，取值：

• Basic：基础版。

• HighAvailability：高可用版。

• cluster：MySQL集群版。
• AlwaysOn：SQL Server集群版。
• Finance：三节点企业版。
• Serverless_basic：Serverless基础版。

专属集群主机组ID。

在专属集群内创建RDS实例时需要指定。

专属集群中主实例的主机ID。

在专属集群内创建RDS实例时需要指定。如不指定该参数，系统默认自动分配主机。

专属集群中备实例的主机ID。

在专属集群内创建RDS高可用版或三节点企业版实例时需要指定。如不指定该参数，系统默认自动分配主机。

专属集群中日志实例的主机ID。

在专属集群内创建RDS三节点企业版实例时需要指定。如不指定该参数，系统默认自动分配主机。

参数模板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：高可用版或基础版。
  • xcluster：MySQL 5.7三节点企业版。
  • xcluster80：MySQL 8.0三节点企业版。

• PostgreSQL：rds_postgres_<大版本>00_<小版本号>。例如rds_postgres_1400_20220830。说明如下：
  • 1400：PostgreSQL大版本为14。
  • 20220830：AliPG内核小版本，可通过调用DescribeDBMiniEngineVersions接口查询。各版本差异，请参见PostgreSQL 小版本Release Notes。

存储空间自动扩容开关，取值：

• Enable：开启。
• Disable：关闭（默认）。

存储空间自动扩容触发阈值（百分比），取值：

• 10
• 20
• 30
• 40
• 50

存储空间自动扩容的总存储空间上限值，即自动扩容不会导致实例总存储空间超过该值。单位：GB。

• 取值需大于等于0。
• StorageAutoScale为Enable时必填。

是否对本次创建实例的操作执行预检查，取值：

• 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位；特殊字符包括! @ # $ % ^ & * () _ + - = 。

数据库连接地址。

创建实例预检查是否通过。返回值：

• true：通过
• false：未通过
  说明

  • 如不执行预检查，则不返回该参数。
  • 如预检查未通过，则返回对应错误。

实例是否成功绑定标签。返回值：

• true：成功。
• false：失败。

请求ID。

数据库连接地址。

批量创建任务的提示信息。

实例ID。若给Amount参数指定大于1的值, 将返回与该值对应的实例ID个数，以逗号分隔。

例如Amount参数为3，则返回3个实例ID。示例：

数据库连接端口。

批量创建任务的任务ID。

表示当前请求需要在创建实例前执行预检查。

订单ID。