CreateDBInstance_云数据库 RDS_API文档-阿里云OpenAPI开发者门户

接口说明

适用引擎

RDS MySQL
RDS PostgreSQL
RDS SQL Server
RDS MariaDB

流控信息

请求速率为50/1(s)。更多流控信息，请前往配额中心查看

授权信息

如下是此API对应的授权信息，用于RAM权限策略语句的Action元素中，为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置，使用方法可参考访问控制帮助文档。

具体说明如下：展开详情

操作	访问级别	资源类型	条件关键字	关联操作

rds:CreateDBInstance	Create	全部资源 *	rds:ResourceTag	无

请求参数

字段名称	字段详情
RegionIdstring	地域 ID。可调用 DescribeRegions 获取。示例值:cn-hangzhou参考取值来源: DescribeRegions
Enginestring	数据库类型，取值：展开详情示例值:MySQL
EngineVersionstring	数据库版本，取值：展开详情示例值:8.0参考取值来源: DescribeDBMiniEngineVersions
DBInstanceClassstring	实例规格。可以指定标准版或倚天版规格，详情请参见主实例规格表。展开详情示例值:mysql.n2.medium.2c参考取值来源: DescribeDBInstances CreateReadOnlyDBInstance
DBInstanceStorageinteger<int32>	实例存储空间，单位为 GB。每 5 GB 进行递增，取值范围请参见实例规格表。示例值:100
SystemDBCharsetstring	弃用参数，无需配置。示例值:gbk
DBInstanceNetTypestring	实例的网络连接类型。固定配置 Intranet，表示内网连接。示例值:Intranet枚举值:参考取值来源: CreateDdrInstance DescribeDBInstances
DBInstanceDescriptionstring	实例名称。长度为 2~255 个字符。以中文、英文字母开头，可以包含数字、中文、英文、下划线（_）、短横线（-）。展开详情示例值:testInstance
SecurityIPListstring	该实例的 IP 白名单。多条记录请以半角逗号（,）隔开，不可重复，单个实例最多添加 1000 个 IP 地址或 IP 段。支持如下两种格式：展开详情示例值:10.10.XX.XX/24参考取值来源: DescribeDBInstanceIPArrayList CreateDdrInstance
ClientTokenstring	用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，要保证在不同请求间唯一，最大值不超过 64 个 ASCII 字符，且该参数值中不能包含非 ASCII 字符。示例值:ETnLKlblzczshOTUbOCz****
PayTypestring	实例的付费类型，取值：展开详情示例值:Postpaid
ZoneIdstring	主节点可用区 ID。展开详情示例值:cn-hangzhou-b
ZoneIdSlave1string	备节点可用区 ID。展开详情示例值:cn-hangzhou-c
ZoneIdSlave2string	RDS MySQL 集群系列实例支持在新建实例时，同时创建 1~2 个备节点。有此需求时，您可通过本参数指定第 2 个备节点的可用区。示例值:cn-hangzhou-d
InstanceNetworkTypestring	实例的网络类型，取值：展开详情示例值:VPC参考取值来源: DescribeDBInstanceNetInfo
ConnectionModestring	实例的访问模式，取值：展开详情示例值:Standard
VPCIdstring	专有网络（VPC） ID。展开详情示例值:vpc-****
VSwitchIdstring	虚拟交换机 ID。展开详情示例值:vsw-****参考取值来源: DescribeVSwitches
PrivateIpAddressstring	设置实例的内网 IP。需要在指定交换机的 IP 地址范围内。系统默认通过 VPCId 和 vSwitchId 自动分配。示例值:172.16.XX.XX
UsedTimestring	指定购买时长，取值：展开详情示例值:2枚举值:正则:^\d+$
Periodstring	指定预付费实例为包年或者包月类型，取值：展开详情示例值:Year枚举值:YearMonthDay123
ResourceGroupIdstring	资源组 ID。示例值:rg-acfmy****参考取值来源: DescribeResourceDetails
DBInstanceStorageTypestring	实例存储类型，取值：展开详情示例值:general_essd参考取值来源: DescribeDBInstances
BusinessInfostring	业务扩展参数。示例值:121436975448952
EncryptionKeystring	同地域内的云盘加密的密钥 ID。传入此参数表示开启云盘加密（开启后无法关闭），并且需要传入 RoleARN。展开详情示例值:0d24*****-da7b-4786-b981-9a164dxxxxxx参考取值来源: DescribeDBInstanceEncryptionKey
RoleARNstring	主账号授权 RDS 云服务账号访问 KMS 权限的全局资源描述符（ARN）。您可以通过 CheckCloudResourceAuthorized 接口查看 ARN 信息。展开详情示例值:acs:ram::1406****:role/aliyunrdsinstanceencryptiondefaultrole
AutoRenewstring	实例是否自动续费，仅在创建包年包月实例时传入，取值：展开详情示例值:true
Categorystring	实例系列，取值：展开详情示例值:HighAvailability
DedicatedHostGroupIdstring	专属集群主机组 ID。展开详情示例值:dhg-4n****参考取值来源: DescribeDedicatedHostGroups
TargetDedicatedHostIdForMasterstring	专属集群中主实例的主机 ID。展开详情示例值:i-bp****
TargetDedicatedHostIdForSlavestring	专属集群中备实例的主机 ID。展开详情示例值:i-bp****
TargetDedicatedHostIdForLogstring	专属集群中日志实例的主机 ID。展开详情示例值:i-bp****
DBParamGroupIdstring	参数模板 ID。可调用 DescribeParameterGroups 查询。展开详情示例值:rpg-sys-****
DBTimeZonestring	设置实例的时区，仅在 Engine 为 MySQL 或 PostgreSQL 时生效。展开详情示例值:+08:00
DBIsIgnoreCasestring	表名是否区分大小写，取值：展开详情示例值:true
TargetMinorVersionstring	指定创建的 RDS 实例的内核小版本，仅在创建 MySQL 或 PostgreSQL 实例时需要传入。展开详情示例值:rds_20200229参考取值来源: UpgradeDBInstanceKernelVersion
StorageAutoScalestring	存储空间自动扩容开关，仅 MySQL 和 PostgreSQL 支持，取值：展开详情示例值:Disable枚举值:EnableDisable
StorageThresholdinteger<int32>	存储空间自动扩容触发阈值（百分比），取值：展开详情示例值:50枚举值:1020304050
StorageUpperBoundinteger<int32>	存储空间自动扩容的总存储空间上限值，即自动扩容不会导致实例总存储空间超过该值。单位：GB。展开详情示例值:2000取值 >= 0
DryRunboolean	是否对本次创建实例的操作执行预检查，取值：展开详情示例值:false
UserBackupIdstring	用户备份 ID。可调用 ListUserBackupFiles 接口查询。传入该参数，可基于用户备份创建实例。展开详情示例值:67798****
Amountinteger<int32>	指定需要创建的 RDS MySQL 实例数量。本参数仅适用于批量创建 RDS MySQL 实例。展开详情示例值:2
CreateStrategystring	批量创建实例策略。本参数仅在 Amount 参数大于 1 时生效，取值：展开详情示例值:Atomicity
Tagarray<object>	标签列表。子级条数 <= 21
DeletionProtectionboolean	是否开启 RDS 释放保护功能，仅按量付费实例支持，取值：展开详情示例值:true
BabelfishConfigstring	Babelfish for RDS PostgreSQL 配置信息。展开详情示例值:{"babelfishEnabled":"true","migrationMode":"single-db","masterUsername":"babelfish_user","masterUserPassword":"Babelfish123!"}
ServerlessConfigobject	RDS Serverless 实例的相关设置。创建 Serverless 实例时必传。展开详情
ConnectionStringstring	数据库内网连接地址。示例值:rm-uf6wjk5****.mysql.rds.aliyuncs.com参考取值来源: AllocateInstancePublicConnection
Portstring	支持在创建 RDS 实例时初始化端口。取值范围：展开详情示例值:3306
BpeEnabledstring	弃用参数，无需配置。示例值:0
BurstingEnabledboolean	通用云盘 IO 突发功能开关。展开详情示例值:false
AutoPayboolean	是否自动支付。取值范围：展开详情示例值:true
IoAccelerationEnabledstring	是否开启通用云盘 IO 加速功能，参数取值含义如下：展开详情示例值:0
ColdDataEnabledboolean	通用云盘数据归档功能开关。展开详情示例值:false
WhitelistTemplateListstring	白名单列表。展开详情示例值:192.168.0.1,172.16.213.9
AutoCreateProxyboolean	是否自动创建代理。取值范围：展开详情示例值:false
AutoUseCouponboolean	是否使用代金券，取值：展开详情示例值:true
PromotionCodestring	优惠券 code。示例值:aliwood-1688-mobile-promotion
OptimizedWritesstring	写优化功能开关，取值：展开详情示例值:optimized枚举值:optimizednone

返回参数

字段名称	字段详情
DryRunResultboolean	创建实例预检查是否通过。返回值：展开详情示例值:true
TagResultboolean	实例是否成功绑定标签。返回值：展开详情示例值:true
RequestIdstring	请求 ID。示例值:1E43AAE0-BEE8-43DA-860D-EAF2AA0724DC
ConnectionStringstring	实例内网连接地址。示例值:rm-uf6wjk5****.mysql.rds.aliyuncs.com
Messagestring	批量创建任务的提示信息。展开详情示例值:Batch Create DBInstance Task Is In Process.
DBInstanceIdstring	实例 ID。若给 Amount 参数指定大于 1 的值, 将返回与该值对应的实例 ID 个数，以逗号分隔。展开详情示例值:rm-uf6wjk5****
Portstring	实例内网连接地址对应端口号。示例值:3306
TaskIdstring	批量创建任务的任务 ID。展开详情示例值:s2365879-a9d0-55af-fgae-f2****
DryRunboolean	表示当前请求需要在创建实例前执行预检查。展开详情示例值:true
OrderIdstring	订单 ID。示例值:1007893702****

返回说明

说明使用新版 SDK 包调用本接口时，由于 SDK 内部的客户端默认超时时间和服务端的不一致，因此可能返回请求超时的错误，但实际上接口已调用成功。如需避免这个问题，您可以在调用前设置 ReadTimeout 参数为 20000。设置调用超时时间

返回示例

变更历史

暂无变更历史

CreateDBInstance_云数据库 RDS_API文档