接口说明
适用引擎
- RDS MySQL
- RDS PostgreSQL
- RDS SQL Server
- RDS MariaDB
相关功能文档
流控信息
请求参数
字段名称 | 字段详情 |
---|---|
ClientTokenstring | 用于保证请求的幂等性,防止重复提交请求。由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过 64 个 ASCII 字符,且该参数值中不能包含非 ASCII 字符。 示例值:0c593ea1-3bea-11e9-b96b-88********** |
RegionIdstring | 地域 ID。可以通过接口 DescribeRegions 查看地域 ID。 示例值:cn-hangzhou参考取值来源: DescribeRegions |
ZoneIdstring | 主可用区 ID。可以通过接口 DescribeRegions 查看可用区 ID。展开详情 示例值:cn-hangzhou-b |
DBInstanceClassstring | |
DBInstanceStorageinteger<int32> | |
DBInstanceDescriptionstring | 实例名称。长度为 2~255 个字符。以中文、英文字母开头,可以包含数字、中文、英文、下划线(_)、短横线(-)。展开详情 示例值:testInstance |
DbNamesstring | 数据库名称,格式如下: 示例值:test1,test2 |
PayTypestring | 付费类型,取值:展开详情 示例值:Postpaid |
InstanceNetworkTypestring | 实例的网络类型,取值:展开详情 示例值:VPC参考取值来源: DescribeDBInstanceNetInfo |
DBInstanceIdstring | 实例 ID。 示例值:rm-uf6wjk5****参考取值来源: CreateDBInstance ReceiveDBInstance ModifyDBInstanceSpec RecoveryDBInstance DescribeDBInstances GetDbProxyInstanceSsl CalculateDBInstanceWeight MigrateDBNodes UpgradeDBInstanceMajorVersion TransformDBInstancePayType EvaluateLocalExtendDisk RestoreDdrTable RebuildReplicationLink |
BackupIdstring | 备份集 ID。展开详情 示例值:902****参考取值来源: DescribeBackups ImportUserBackupFile UpdateUserBackupFile ListUserBackupFiles |
RestoreTimestring | 备份保留周期内的任意时间点。格式:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。展开详情 示例值:2011-06-11T16:00:00Z |
VPCIdstring | 专有网络 VPC ID。展开详情 示例值:vpc-uf6f7l4fg90**** |
VSwitchIdstring | 虚拟交换机 ID。虚拟交换机所在的可用区必须和 ZoneId 中传入的可用区 ID 相对应。展开详情 示例值:vsw-uf6adz52c2p****参考取值来源: DescribeVSwitches |
PrivateIpAddressstring | 新实例的内网 IP,需要在指定交换机的 IP 地址范围内。系统默认通过 VPCId 和 VSwitchId 自动分配。 示例值:172.XX.XX.69 |
UsedTimeinteger<int32> | 购买时长,取值:展开详情 示例值:1 |
Periodstring | 预付费实例为包年或者包月类型,取值:展开详情 示例值:Year枚举值:YearMonth |
Categorystring | 实例系列,取值:展开详情 示例值:HighAvailability |
ZoneIdSlave1string | 备节点可用区 ID。如果和 ZoneId 相同,则为单可用区部署;如果和 ZoneId 不同,则为多可用区部署。 示例值:cn-hangzhou-c |
ZoneIdSlave2string | 备节点或日志节点可用区 ID。如果和 ZoneId 相同,则为单可用区部署;如果和 ZoneId 不同,则为多可用区部署。 示例值:cn-hangzhou-d |
DBInstanceStorageTypestring | 实例存储类型,取值:展开详情 示例值:general_essd参考取值来源: CreateDBInstance DescribeDBInstances |
RestoreTablestring | 是否进行库表恢复,取值为 1 时表示进行库表恢复,否则不填。 示例值:1 |
TableMetastring | 进行库表恢复时,指定恢复的库表信息。格式:展开详情 示例值:[{"type":"db","name":"testdb1","newname":"testdb1_new","tables":[{"type":"table","name":"testdb1table1","newname":"testdb1table1_new"}]}] |
DedicatedHostGroupIdstring | 专属集群 ID。 示例值:dhg-7a9****参考取值来源: DescribeDedicatedHostGroups |
BackupTypestring | 备份类型,取值:展开详情 示例值:FullBackup参考取值来源: DescribeBackups |
DeletionProtectionboolean | 是否开启释放保护功能。取值:展开详情 示例值:true |
ServerlessConfigobject | Serverless 选项。仅在需要将数据克隆至 Serverless 实例时传入。展开详情 |
BpeEnabledstring | 弃用参数,无需配置。 示例值:0 |
IoAccelerationEnabledstring | 高性能云盘的 Buffer Pool Extension(BPE)功能开关,取值:展开详情 示例值:0 |
BurstingEnabledboolean | 高性能云盘的 IO 性能突发功能开关。展开详情 示例值:false |
AutoPayboolean | 是否自动支付。展开详情 示例值:true |
返回参数
字段名称 | 字段详情 |
---|---|
DBInstanceIdstring | 实例 ID。 示例值:rm-uf6wjk5**** |
OrderIdstring | 订单 ID。 示例值:100789370**** |
RequestIdstring | 请求 ID。 示例值:1E43AAE0-BEE8-43DA-860D-EAF2**** |