接口说明
适用引擎
- RDS MySQL
- RDS PostgreSQL
- RDS SQL Server
相关功能文档
流控信息
授权信息
当前云产品暂无权限信息透出。
请求参数
| 字段名称 | 字段详情 |
|---|---|
ClientTokenstring | 用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，要保证在不同请求间唯一，最大值不超过 64 个 ASCII 字符，且该参数值中不能包含非 ASCII 字符。 示例值:ETnLKlblzczshOTUbOC**** |
RegionIdstring | 地域 ID。只读实例的地域必须和主实例相同。可调用 DescribeRegions 获取。 示例值:cn-hangzhou参考取值来源: DescribeRegions |
ZoneIdstring | 可用区 ID。可调用 DescribeRegions 获取。展开详情 示例值:cn-hangzhou-b |
DBInstanceIdstring | 主实例 ID。可调用 DescribeDBInstances 获取。 示例值:rm-uf6wjk5****参考取值来源: CloneDBInstance CreateDBInstance ReceiveDBInstance ModifyDBInstanceSpec RecoveryDBInstance DescribeDBInstances CalculateDBInstanceWeight MigrateDBNodes UpgradeDBInstanceMajorVersion TransformDBInstancePayType EvaluateLocalExtendDisk RestoreDdrTable RebuildReplicationLink |
DBInstanceClassstring | 实例规格，详见只读实例规格列表。建议只读实例规格不小于主实例规格，否则易导致只读实例延迟高、负载高等现象。 示例值:mysqlro.n2.small.1c参考取值来源: CreateDBInstance DescribeDBInstances |
DBInstanceStorageinteger<int32> | 存储空间，只读实例存储空间需要大于或等于主实例存储空间。取值：请参见只读实例规格列表的存储空间列。每 5 GB 进行递增，单位：GB。 示例值:20 |
EngineVersionstring | 数据库版本号。必须与主实例相同。展开详情 示例值:5.6参考取值来源: DescribeDBMiniEngineVersions |
PayTypestring | 付费类型，取值：展开详情 示例值:Postpaid |
DBInstanceDescriptionstring | 实例描述，长度为 2~256 个字符。以中文、英文字母开头，可以包含数字、中文、英文、下划线（_）、短横线（-）。展开详情 示例值:testReadOnly |
InstanceNetworkTypestring | 只读实例的网络类型，取值：展开详情 示例值:Classic参考取值来源: DescribeDBInstanceNetInfo |
VPCIdstring | 只读实例的专有网络 VPC ID。当 InstanceNetworkType 配置为空或 VPC 时需要传入。展开详情 示例值:vpc-uf6f7l4fg90**** |
VSwitchIdstring | 只读实例的虚拟交换机 ID。当 InstanceNetworkType 配置为空或 VPC 时需要传入。 示例值:vsw-uf6adz52c2p****参考取值来源: DescribeVSwitches |
PrivateIpAddressstring | 设置只读实例的内网 IP，需要在指定交换机的 IP 地址范围内。系统默认通过 VPCId 和 VSwitchId 自动分配。 示例值:172.16.XX.XX |
ResourceGroupIdstring | 资源组 ID。 示例值:rg-acfmy****参考取值来源: DescribeResourceDetails |
Categorystring | 实例系列，取值：展开详情 示例值:HighAvailability |
DBInstanceStorageTypestring | 实例储存类型，取值：展开详情 示例值:local_ssd参考取值来源: CreateDBInstance DescribeDBInstances |
DedicatedHostGroupIdstring | 在专属集群内创建只读实例时指定专属集群 ID。 示例值:dhg-4n****参考取值来源: DescribeDedicatedHostGroups |
TargetDedicatedHostIdForMasterstring | 在专属集群内创建只读实例时，指定主实例的主机 ID。 示例值:i-bp**** |
GdnInstanceNamestring | 备用参数。 示例值:test |
TddlBizTypestring | 备用参数。 示例值:test |
TddlRegionConfigstring | 备用参数。 示例值:test |
InstructionSetArchstring | 备用参数。 示例值:test |
UsedTimestring | 指定购买时长。取值：展开详情 示例值:1 |
Periodstring | 指定预付费实例为包年或者包月类型。取值：展开详情 示例值:Month |
AutoRenewstring | 实例是否自动续费，仅在创建包年包月实例时传入。取值：展开详情 示例值:true |
DeletionProtectionboolean | 是否开启 RDS 释放保护功能。取值：展开详情 示例值:true |
Portstring | 支持在 RDS MySQL 主实例创建只读实例时初始化端口。展开详情 示例值:3306 |
BpeEnabledstring | 弃用参数，无需配置。 示例值:0 |
BurstingEnabledboolean | 通用云盘 IO 突发功能开关。展开详情 示例值:false |
AutoPayboolean | 是否自动支付。展开详情 示例值:false |
AutoCreateProxyboolean | 是否自动创建代理。取值范围：展开详情 示例值:false |
IoAccelerationEnabledstring | 是否开启通用云盘 IO 加速功能，参数取值含义如下：展开详情 示例值:0 |
AutoUseCouponboolean | 是否使用代金券，取值：展开详情 示例值:true |
PromotionCodestring | 优惠券 code。 示例值:717446260784 |
返回参数
| 字段名称 | 字段详情 |
|---|---|
ConnectionStringstring | 创建的只读实例内网数据库连接地址。 示例值:rr-****.mysql.rds.aliyuncs.com |
DBInstanceIdstring | 创建的只读实例 ID。 示例值:rr-uf6wjk5**** |
OrderIdstring | 订单 ID。 示例值:10078937**** |
Portstring | 创建的只读实例内网数据库连接端口。 示例值:3306 |
RequestIdstring | 请求 ID。 示例值:1E43AAE0-BEE8-43DA-860D-EAF2AA0724DC |