云数据库RDS提供以下相关API接口。

热门API TOP 10

API描述
CreateDBInstance创建一个RDS实例。
DescribeDBInstances查询RDS实例列表或被RAM授权的实例列表。
DescribeDBInstanceAttribute查询RDS实例的详细信息。
DescribeDBInstancePerformance查询RDS实例性能数据。
DescribeSlowLogRecords查询RDS实例的慢日志明细。
DescribeSlowLogs查询RDS实例慢日志统计情况。
DescribeBackups查询RDS实例备份集列表。
DescribeResourceUsage查询RDS实例的空间使用信息。
CreateAccount创建管理数据库的账号。
CreateDatabase创建数据库。

费用

API描述
DescribePrice查询实例的价格。
DescribeRenewalPrice查询RDS实例续费的费用。
TransformDBInstancePayType变更RDS实例的计费方式。
RenewInstance手动续费RDS实例。

实例

API描述
CreateDBInstance创建一个RDS实例。
DeleteDBInstance释放RDS实例。
RestartDBInstance重启RDS实例。
StopDBInstance暂停RDS实例。
StartDBInstance启用RDS实例。
ModifyDBInstanceSpec变更RDS实例（包括常规实例和只读实例，不包括灾备实例和临时实例）的规格或存储空间。
ModifyDasInstanceConfig设置实例存储空间自动扩容。
DescribeAvailableZones查询RDS可用区资源。
DescribeAvailableClasses查询实例可变更规格，包括规格代码和存储空间。
DescribeDBInstanceAttribute查询RDS实例的详细信息。
GetDBInstanceTopology获取RDS实例的拓扑结构。
DescribeDBInstances查询RDS实例列表或被RAM授权的实例列表。
ListClasses查询RDS实例所有规格的详情。
DescribeDBInstancesByExpireTime通过过期时间查询RDS实例信息。
DescribeRegions查询当前可选的RDS地域和可用区信息。
MigrateToOtherZone迁移RDS实例至其他可用区。
ModifyDBInstanceDescription修改RDS实例的描述。
ModifyDBInstanceMaintainTime修改RDS实例可维护时间段。
ModifyResourceGroup将RDS实例移动到指定资源组。
CheckInstanceExist查询实例是否存在。
ModifyHADiagnoseConfig修改阿里云对目标RDS实例的可用性检测方式。
DescribeHADiagnoseConfig查询阿里云对目标RDS实例的可用性检测方式。
DescribeAnalyticdbByPrimaryDBInstance查询RDS MySQL实例关联的分析型实例。
CheckCloudResourceAuthorized查询云资源的权限状态。

升级版本

API描述
UpgradeDBInstanceEngineVersion升级实例数据库版本。
UpgradeDBInstanceKernelVersion升级RDS实例的内核小版本。
ModifyDBInstanceAutoUpgradeMinorVersion修改RDS实例升级内核小版本的方式。
UpgradeDBInstanceMajorVersionPrecheck执行RDS PostgreSQL实例大版本升级前检查。
DescribeUpgradeMajorVersionPrecheckTask查询RDS PostgreSQL实例大版本升级前检查报告。
UpgradeDBInstanceMajorVersion发起RDS PostgreSQL实例大版本升级。
DescribeUpgradeMajorVersionTasks查询RDS PostgreSQL实例大版本升级的历史任务。

网络与连接地址

API描述
AllocateInstancePublicConnection申请RDS实例的外网地址。
DescribeDBInstanceNetInfo查询RDS实例的所有连接地址信息。
ModifyDBInstanceConnectionString修改RDS实例的连接地址和端口。
ModifyDBInstanceNetworkExpireTime修改RDS实例连接地址过期时间。
SwitchDBInstanceNetType切换RDS实例内外网地址。
ReleaseInstancePublicConnection释放RDS实例的外网连接地址。
ModifyDBInstanceNetworkType切换RDS实例网络类型。
SwitchDBInstanceVpc切换RDS实例的专有网络VPC或交换机。
DescribeVSwitches查询专有网络VPC下虚拟交换机的详细信息。

主备高可用和数据复制方式

API描述
ModifyDBInstanceHAConfig修改RDS实例的高可用模式和数据复制方式。
DescribeDBInstanceHAConfig查询RDS实例高可用模式和数据复制方式。
SwitchDBInstanceHA切换RDS实例的主备实例。
ModifyHASwitchConfig开启或关闭RDS实例的主备自动切换功能。
DescribeHASwitchConfig查询RDS实例主备自动切换设置。

历史事件

API描述
DescribeEvents查询RDS事件记录列表。
DescribeActionEventPolicy查询RDS历史事件功能开启情况。
ModifyActionEventPolicy开启或关闭RDS历史事件功能。

通知

API描述
QueryNotify查询RDS通知列表。
ModifyActionEventPolicy开启或关闭RDS历史事件功能。

CloudDBA数据库性能优化

API描述
CreateDiagnosticReport创建诊断报告。
DescribeDiagnosticReportList获取诊断报告列表。

账号

API描述
CreateAccount创建管理数据库的账号。
DeleteAccount删除数据库账号。
ResetAccountPassword重置账号密码。
LockAccount锁定RDS PostgreSQL实例的账号。
UnlockAccount解锁RDS PostgreSQL实例的账号。
DescribeAccounts查询RDS实例的账号信息。
ModifyAccountDescription修改数据库账号的描述。
DescribeInstanceKeywords查询RDS实例的保留关键字，即创建数据库或账号时禁用的关键字。
ModifyPGHbaConfig修改RDS PostgreSQL实例的pg_hba.conf文件配置。
DescribePGHbaConfig查询RDS PostgreSQL实例的pg_hba.conf文件的配置。
DescribeModifyPGHbaConfigLog查询RDS PostgreSQL实例的pg_hba.conf文件的修改记录。
GrantAccountPrivilege授权账号访问数据库。
GrantOperatorPermission授予服务账号权限。
RevokeOperatorPermission撤销服务账号权限。
RevokeAccountPrivilege撤销账号对数据库的访问权限。
ResetAccount重置高权限账号的权限。

数据库

API描述
CreateDatabase创建数据库。
DeleteDatabase删除RDS实例下的某个数据库。
ModifyDBDescription修改数据库备注。
CopyDatabaseBetweenInstances在RDS实例间复制数据库。
DescribeDatabases查询RDS实例下的数据库信息。
CheckDBNameAvailable检查数据库名称是否可用。
DescribeCollationTimeZones查询支持的字符集排序规则和时区。
DescribeCharacterSetName查询RDS实例支持的字符集。

只读实例

API描述
CreateReadOnlyDBInstance为某个RDS实例创建一个只读实例。
DescribeReadDBInstanceDelay查询RDS只读实例的延迟信息。
ModifyReadonlyInstanceDelayReplicationTime修改RDS只读实例的延迟复制时间。

集群版实例

API描述
CreateDBNodes新增集群版实例节点。
DeleteDBNodes删除集群版实例节点。
DescribeDBInstanceEndpoints查询实例的Endpoint信息。
CreateDBInstanceEndpoint创建实例的Endpoint。
DeleteDBInstanceEndpoint删除实例的Endpoint。
ModifyDBInstanceEndpoint修改实例Endpoint信息。
CreateDBInstanceEndpointAddress创建实例外网连接地址。
DeleteDBInstanceEndpointAddress删除实例的外网连接地址。
ModifyDBInstanceEndpointAddress修改实例的Endpoint连接地址。

数据库共享代理（下线中）

API描述
AllocateReadWriteSplittingConnection申请读写分离地址。
ReleaseReadWriteSplittingConnection释放读写分离地址。
CalculateDBInstanceWeight查询系统权重分配值。
ModifyReadWriteSplittingConnection修改读写分离链路的延迟阈值和各个实例的读权重。
DescribeDBInstanceProxyConfiguration查询数据库代理设置。

数据库独享代理（读写分离）

API描述
ModifyDBProxy开启或者关闭RDS实例的数据库独享代理功能。
UpgradeDBProxyInstanceKernelVersion升级独享代理内核小版本。
ModifyDBProxyInstance修改RDS数据库独享代理数量。
ModifyDBProxyEndpoint修改RDS实例数据库独享代理的连接地址配置（读写分离、事务拆分、连接池）。
DescribeDBProxy查询RDS实例的数据库独享代理详情。
DescribeDBProxyEndpoint查询RDS实例独享代理的连接地址信息。
DescribeDBProxyPerformance查询独享代理的性能数据。
CreateDBProxyEndpointAddress创建RDS实例独享代理的连接地址。
ModifyDBProxyEndpointAddress修改RDS实例独享代理的连接地址。
DeleteDBProxyEndpointAddress删除RDS实例独享代理的连接地址。
ModifyDbProxyInstanceSsl设置RDS实例独享代理连接地址SSL加密。
GetDbProxyInstanceSsl查询RDS实例独享代理连接地址SSL加密信息。

安全加密

API描述
DescribeSecurityGroupConfiguration查询指定RDS实例和ECS安全组的关联信息。
ModifySecurityGroupConfiguration修改指定RDS实例和ECS安全组的关联信息。
DescribeDBInstanceIPArrayList查询RDS实例IP白名单。
ModifySecurityIps修改IP白名单。
DescribeDBInstanceSSL查询RDS实例SSL设置。
ModifyDBInstanceSSL修改RDS实例SSL链路。
DescribeDBInstanceTDE查询RDS实例数据加密状态。
ModifyDBInstanceTDE开启RDS实例透明数据加密功能。
MigrateSecurityIPMode白名单从通用模式切换为高安全模式。
DescribeDBInstanceIpHostname查询RDS实例的底层ECS实例的hostname。
DescribeDTCSecurityIpHostsForSQLServer查询RDS实例的分布式事务白名单信息。
ModifyDTCSecurityIpHostsForSQLServer设置分布式事务白名单。
DescribeDBInstanceEncryptionKey查询RDS实例的云盘加密状态及密钥详情。
CreateServiceLinkedRole创建服务关联角色（SLR）。
ModifyDBInstanceDeletionProtection开启或关闭RDS实例的释放保护功能。

日志

API描述
ModifySQLCollectorPolicy开启或关闭实例的SQL洞察（SQL审计）功能。
DescribeSQLCollectorPolicy查询RDS实例的SQL审计或SQL洞察功能是否开启。
DescribeSQLLogRecords查询RDS实例的SQL洞察（SQL审计）日志。
DescribeSQLLogFiles查询SQL洞察（SQL审计）文件列表。
ModifySQLCollectorRetention修改RDS实例的SQL洞察日志保存时长。
DescribeSQLCollectorRetention查询RDS实例的SQL洞察日志保存时长。
DescribeSlowLogs查询慢日志统计情况。
DescribeSlowLogRecords查询RDS实例的慢日志明细。
DescribeErrorLogs查询RDS实例某段时间内的错误日志。
PurgeDBInstanceLog清理或收缩RDS实例日志。
DescribeSQLLogReports查询实例的SQL日志运行报告。
DescribeSQLLogReportList查看实例的SQL日志运行报告列表。

备份

API描述
CreateBackup创建一个备份集。
DescribeBackups查询备份集列表。
DescribeDetachedBackups查看已删除实例的备份集列表。
DescribeBackupPolicy查询RDS实例备份设置。
ModifyBackupPolicy修改备份设置。
DeleteBackup删除数据备份文件。
DescribeBackupTasks查询RDS实例的备份任务列表。
DescribeBinlogFiles查询Binlog日志。

恢复

API描述
RecoveryDBInstance恢复数据库。
CloneDBInstance将历史数据恢复至一个新实例（称为克隆实例）。
CreateTempDBInstance创建临时实例。
DescribeLocalAvailableRecoveryTime查询RDS实例备份可恢复的时间范围。
RestoreTable恢复RDS实例的某些数据库或表到原实例。
DescribeMetaList查询目标备份集中可恢复的库表信息。

跨地域备份恢复

API描述
CheckCreateDdrDBInstance预检查某RDS实例是否可以用跨地域备份集进行跨地域恢复。
CreateDdrInstance跨地域恢复数据到新实例。
RestoreDdrTable跨地域恢复数据到已有实例。
ModifyInstanceCrossBackupPolicy修改RDS跨地域备份设置。
DescribeInstanceCrossBackupPolicy查询跨地域备份设置。
DescribeCrossBackupMetaList查询跨地域备份的库表信息。
DescribeCrossRegionBackups查询某RDS实例跨地域数据备份文件列表。
DescribeCrossRegionLogBackupFiles查询跨地域日志备份文件列表。
DescribeAvailableCrossRegion查询所选地域当前可以进行跨地域备份的目的地域。
DescribeAvailableRecoveryTime查询某跨地域备份文件可恢复哪个时间段的数据。
DescribeCrossRegionBackupDBInstance查询所选地域的哪些实例开启了跨地域备份，以及这些实例的跨地域备份设置。

监控

API描述
DescribeResourceUsage查询实例的空间使用信息。
DescribeDBInstancePerformance查询实例性能数据。
DescribeDBInstanceMonitor查询监控频率。
ModifyDBInstanceMonitor修改监控频率。
DescribeAvailableMetrics获取RDS PostgreSQL实例支持的所有增强监控指标。
ModifyDBInstanceMetrics变更RDS PostgreSQL实例需要展示的增强监控指标。
DescribeDBInstanceMetrics查询RDS PostgreSQL实例已开启的增强指标。

参数

API描述
DescribeParameters查询实例当前的参数配置。
ModifyParameter修改实例参数。
DescribeModifyParameterLog查询RDS实例的参数修改日志。
DescribeParameterTemplates查询数据库参数模板。
CreateParameterGroup创建RDS参数模板。
ModifyParameterGroup修改RDS参数模板。
CloneParameterGroup复制RDS参数模板到当前地域或其他地域内。
DescribeParameterGroups查询目标地域的参数模板列表。
DescribeParameterGroup查询指定的RDS参数模板信息。
DeleteParameterGroup删除RDS参数模板。

数据迁移

API描述
ImportDatabaseBetweenInstances从其它RDS实例迁入数据。
CancelImport取消RDS SQL Server实例迁移任务。

MySQL备份文件上云

API描述
ImportUserBackupFile将自建库MySQL的备份数据导入至RDS。
UpdateUserBackupFile变更用户备份的备注信息和保留时长。
ListUserBackupFiles查询所有已导入至RDS的用户备份的详情。
DeleteUserBackupFile删除目标用户备份。

SQL Server备份文件上云

API描述
CreateMigrateTask将OSS上的备份文件还原到RDS实例，实现数据上云。
DescribeMigrateTasks查询备份数据上云任务列表。
DescribeOssDownloads查询备份数据上云任务的文件详情。
CreateOnlineDatabaseTask打开RDS SQL Server备份数据上云任务的数据库。
DescribeMigrateTaskById查询SQL Server的某个OSS备份上云任务的信息。
TerminateMigrateTask终止RDS实例迁移任务。

SQL Server AD域

API描述
ModifyADInfo修改RDS SQL Server实例的AD域信息。
DeleteADSetting移除RDS SQL Server实例的AD域信息。
DescribeADInfo查询RDS SQL Server实例的AD域信息。

SQL Server集群管理

API描述
AllocateReadWriteSplittingConnection申请RDS实例的读写分离地址。
ReleaseReadWriteSplittingConnection释放RDS实例的读写分离地址。
CalculateDBInstanceWeight查询系统权重分配值。
ModifyReadWriteSplittingConnection修改读写分离链路的延迟阈值和各个实例的读权重。

PostgreSQL一键上云

API描述
CreateCloudMigrationPrecheckTask创建RDS PostgreSQL一键上云前检查任务。
DescribeCloudMigrationPrecheckResult查询一键上云前检查报告。
CreateCloudMigrationTask创建RDS PostgreSQL迁移上云任务。
ActivateMigrationTargetInstance执行RDS PostgreSQL上云切换，将RDS PostgreSQL提升为主库，正式提供服务。
DescribeCloudMigrationResult查询RDS PostgreSQL迁移上云任务详情。

全球多活数据库集群

API描述
DescribeGadInstances查询RDS全球多活数据库集群列表或目标集群的详细信息。
CreateGADInstance创建RDS全球多活数据库集群。
CreateGadInstanceMember在RDS全球多活数据库集群中添加单元节点。
DeleteGadInstance删除RDS全球多活数据库集群。
DetachGadInstanceMemer移除RDS全球多活数据库集群中的单元节点。

标签

API描述
TagResources为指定的RDS实例创建并绑定标签。
UntagResources为指定的RDS实例解绑标签。
ListTagResources查询一个或多个RDS实例已经绑定的标签列表。