阿里云RDS数据库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
  • PostgreSQL：10.0、11.0、12.0、13.0、14.0、15.0、16.0
  • MariaDB：10.3
• Serverless实例
  • MySQL：5.7、8.0
  • SQL Server：2016_std_sl、2017_std_sl、2019_std_sl
  • PostgreSQL：14.0、15.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。每5GB进行递增，取值范围请参见实例规格表。

弃用参数，无需配置。

实例的网络连接类型。固定配置Intranet，表示内网连接。

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

说明
不能以 http:// 和 https:// 开头。

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

• 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，以此决定实例是单可用区部署还是多可用区部署。
• 对于RDSMySQL集群系列实例，两节点还需要传入ZoneIdSlave1，三节点还需要传入ZoneIdSlave1和ZoneIdSlave2。

备节点可用区ID。

• 如果填写Auto，则表示多可用区部署并且会自动为备节点选择可用区。
• 如果和ZoneId相同，则为单可用区部署。
• 如果和ZoneId不同，则为多可用区部署。

该参数已废弃。

实例的网络类型，取值：

• VPC：专有网络。
• Classic：经典网络。

说明

实例的访问模式，取值：

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

默认为RDS系统分配。

说明
SQL Server 2012、2016、2017只支持标准访问模式。

专有网络（VPC） ID。

说明
网络类型InstanceNetworkType取值为VPC时生效。

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

• 网络类型InstanceNetworkType需为VPC。
• 若您填写了ZoneSlaveId1（备可用区ID），此处需填写两个交换机ID，并使用半角逗号（,）隔开。

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

指定购买时长，取值：

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

说明
若付费类型为Prepaid则该参数必须传入。

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

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

说明
若付费类型为Prepaid则该参数必须传入。

资源组ID。

实例存储类型，取值：

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

本参数的默认值根据DBInstanceClass参数中传的规格代码自动判断：

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

说明
Serverless实例仅支持ESSD PL1云盘，必须传入cloud_essd。

业务扩展参数。

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

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

说明
对于RDS PostgreSQL可不传此参数，仅需要传入RoleARN即可使用服务密钥创建云盘加密实例。

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

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

• true
• false

说明

实例系列，取值：

• 常规实例
  • Basic：基础系列。
  • HighAvailability：高可用系列。
  • cluster：MySQL集群系列。
  • AlwaysOn：SQL Server集群系列。
  • Finance：三节点企业系列。
• Serverless实例

  • serverless_basic：Serverless基础系列。（仅适用MySQL和PostgreSQL）

  • serverless_standard：Serverless高可用系列。（仅适用MySQL和PostgreSQL）

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

  说明
  若创建Serverless实例，该参数必传。

专属集群主机组ID。

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

• 您可以调用DescribeDedicatedHostGroups接口查询RDS主机组信息。
• 如您还未创建RDS主机组，可以调用CreateDedicatedHostGroup接口创建。

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

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

• 您可以调用DescribeDedicatedHosts接口查询RDS主机组内的主机信息。
• 如您还没有主机，可以调用CreateDedicatedHost接口添加。

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

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

• 您可以调用DescribeDedicatedHosts接口查询RDS专属集群内的主机信息。
• 如您还没有主机，可以调用CreateDedicatedHost接口添加。

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

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

• 您可以调用DescribeDedicatedHosts接口查询RDS专属集群内的主机信息。
• 如您还没有主机，可以调用CreateDedicatedHost接口添加。

参数模板ID。可调用DescribeParameterGroups查询。

说明
仅MySQL和PostgreSQL支持此参数，如不配置，将采用系统默认参数模板，您也可以自定义参数模板后，在此处使用。

设置实例的时区，仅在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三节点企业系列。

  说明
  数字版本号可通过调用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：关闭（默认）。

说明
您也可以在实例创建完成之后，调用ModifyDasInstanceConfig进行调整。更多信息，请参见设置存储空间自动扩容。

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

• 10
• 20
• 30
• 40
• 50

说明
StorageAutoScale为Enable时该参数必填。

存储空间自动扩容的总存储空间上限值，即自动扩容不会导致实例总存储空间超过该值。单位：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位；特殊字符包括! @ # $ % ^ & * () _ + - = 。

说明
该参数仅适用于RDS PostgreSQL实例，Babelfish for RDS PostgreSQL的更多介绍，请参见Babelfish简介。

RDS Serverless实例的相关设置。创建Serverless实例时必传。

说明
MariaDB不支持创建Serverless实例。

数据库内网连接地址。

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

• MySQL：1000~65534
• PostgreSQL、SQL Server、MariaDB：1000~5999

预留参数，无需配置。

预留参数，无需配置。

是否自动支付。取值范围：

• true：自动支付。您需要确保账户余额充足。
• false：只生成订单不扣费。

说明
默认值为true。如果您的支付方式余额不足，可以将参数AutoPay设置为false，此时会生成未支付订单，您可以登录RDS管理控制台自行支付。

返回参数详情。