云数据库RDS提供以下相关API接口。
实例
| API | 描述 |
|---|---|
| CreateDBInstance | 调用CreateDBInstance接口创建一个RDS实例。 |
| DeleteDBInstance | 调用DeleteDBInstance接口释放RDS实例。 |
| RestartDBInstance | 调用RestartDBInstance接口重启RDS实例。 |
| RenewInstance | 调用RenewInstance接口对RDS实例进行手动续费。 |
| DescribeDBInstanceAttribute | 调用DescribeDBInstanceAttribute接口查看RDS实例的详细信息。 |
| DescribeDBInstances | 调用DescribeDBInstances接口查看RDS实例列表或被RAM授权的实例列表。 |
| ModifyDBInstanceSpec | 调用ModifyDBInstanceSpec接口变更RDS实例（包括常规实例和只读实例，不包括灾备实例和临时实例）的规格或存储空间。 |
| DescribeRegions | 调用DescribeRegions接口查询当前可选的RDS地域和可用区信息。 |
| MigrateToOtherZone | 调用MigrateToOtherZone接口将RDS实例迁移至其他可用区。 |
| PurgeDBInstanceLog | 调用PurgeDBInstanceLog接口清理或收缩RDS实例日志。 |
| UpgradeDBInstanceEngineVersion | 调用UpgradeDBInstanceEngineVersion接口升级实例数据库版本。 |
| ModifyDBInstanceDescription | 调用ModifyDBInstanceDescription接口修改RDS实例的描述。 |
| ModifyDBInstanceMaintainTime | 调用ModifyDBInstanceMaintainTime接口修改RDS实例可维护时间段。 |
| ModifyDBInstanceAutoUpgradeMinorVersion | 调用ModifyDBInstanceAutoUpgradeMinorVersion接口修改RDS实例升级小版本的方式。 |
| ModifyHASwitchConfig | 调用ModifyHASwitchConfig接口开启或关闭RDS实例的主备自动切换功能。 |
| DescribeHASwitchConfig | 调用DescribeHASwitchConfig接口查看RDS实例主备自动切换设置。 |
| DescribeAvailableResource | 调用DescribeAvailableResource接口查询某地域可售卖资源信息。 |
| UpgradeDBInstanceKernelVersion | 调用UpgradeDBInstanceKernelVersion接口升级RDS MySQL实例的内核小版本。 |
连接地址
| API | 描述 |
|---|---|
| AllocateInstancePublicConnection | 调用AllocateInstancePublicConnection接口申请实例的外网地址。 |
| DescribeDBInstanceNetInfo | 调用DescribeDBInstanceNetInfo接口查看实例的所有连接地址信息。 |
| ModifyDBInstanceConnectionString | 调用ModifyDBInstanceConnectionString接口修改实例的连接地址和端口。 |
| ModifyDBInstanceNetworkExpireTime | 调用ModifyDBInstanceNetworkExpireTime接口修改连接地址过期时间。 |
| SwitchDBInstanceNetType | 调用SwitchDBInstanceNetType接口切换内外网地址。 |
| ReleaseInstancePublicConnection | 调用ReleaseInstancePublicConnection接口释放实例的外网连接地址。 |
主备高可用/数据复制方式
| API | 描述 |
|---|---|
| ModifyDBInstanceHAConfig | 调用ModifyDBInstanceHAConfig接口修改实例的高可用模式和数据复制方式。 |
| DescribeDBInstanceHAConfig | 调用DescribeDBInstanceHAConfig接口查询RDS实例高可用模式和数据复制方式。 |
| SwitchDBInstanceHA | 调用SwitchDBInstanceHA接口切换RDS实例的主备实例。 |
历史事件
| API | 描述 |
|---|---|
| DescribeEvents | 调用DescribeEvents接口查询RDS事件记录列表。 |
| DescribeActionEventPolicy | 调用DescribeActionEventPolicy接口查看RDS历史事件功能开启情况。 |
| ModifyActionEventPolicy | 调用ModifyActionEventPolicy接口开启或关闭RDS历史事件功能。 |
CloudDBA数据库性能优化
| API | 描述 |
|---|---|
| CreateDiagnosticReport | 调用CreateDiagnosticReport接口创建诊断报告。 |
| DescribeDiagnosticReportList | 调用DescribeDiagnosticReportList接口获取诊断报告列表。 |
数据库代理
| API | 描述 |
|---|---|
| DescribeDBInstanceProxyConfiguration | 调用DescribeDBInstanceProxyConfiguration接口查看数据库代理设置，已下线。 |
| ModifyDBProxyInstance | 调用ModifyDBProxyInstance接口修改RDS数据库独享代理设置。 |
| ModifyDBProxy | 调用ModifyDBProxy接口开启或者关闭RDS实例的数据库独享代理功能。 |
| DescribeDBProxy | 调用DescribeDBProxy接口查询RDS实例的数据库独享代理详情。 |
| DescribeDBProxyEndpoint | 调用DescribeDBProxyEndpoint接口查询RDS实例独享代理的连接地址信息。 |
| ModifyDBProxyEndpoint | 调用ModifyDBProxyEndpoint接口修改RDS实例数据库独享代理的连接地址信息。 |
| DescribeDBProxyPerformance | 调用DescribeDBProxyPerformance接口查询独享代理实例的性能数据。 |
数据库
| API | 描述 |
|---|---|
| CreateDatabase | 调用CreateDatabase接口在某个实例下创建数据库。 |
| DeleteDatabase | 调用DeleteDatabase接口删除实例下的某个数据库。 |
| DescribeDatabases | 调用DescribeDatabases接口查看实例下的数据库信息。 |
| ModifyDBDescription | 调用ModifyDBDescription接口修改数据库备注。 |
| CopyDatabaseBetweenInstances | 调用CopyDatabaseBetweenInstances接口在实例间复制数据库。 |
| DescribeCollationTimeZones | 调用DescribeCollationTimeZones接口查看支持的字符集排序规则和时区。 |
只读实例
| API | 描述 |
|---|---|
| CreateReadOnlyDBInstance | 调用CreateReadOnlyDBInstance接口为某个实例创建一个只读实例。 |
| DescribeReadDBInstanceDelay | 调用DescribeReadDBInstanceDelay接口查询RDS只读实例的延迟信息。 |
读写分离
| API | 描述 |
|---|---|
| AllocateReadWriteSplittingConnection | 调用AllocateReadWriteSplittingConnection接口申请读写分离地址。 |
| CalculateDBInstanceWeight | 调用CalculateDBInstanceWeight接口查询系统权重分配值。 |
| ModifyReadWriteSplittingConnection | 调用ModifyReadWriteSplittingConnection接口修改读写分离链路的延迟阈值和各个实例的读权重。 |
| ReleaseReadWriteSplittingConnection | 调用ReleaseReadWriteSplittingConnection接口释放读写分离地址。 |
账号
| API | 描述 |
|---|---|
| CreateAccount | 调用CreateAccount接口创建管理数据库的账号。 |
| DeleteAccount | 调用DeleteAccount接口删除数据库账号。 |
| DescribeAccounts | 调用DescribeAccounts接口查看实例的帐号信息。 |
| GrantAccountPrivilege | 调用GrantAccountPrivilege接口授权账号访问数据库。 |
| RevokeAccountPrivilege | 调用RevokeAccountPrivilege接口撤销账号对数据库的访问权限。 |
| ModifyAccountDescription | 调用ModifyAccountDescription接口修改数据库账号的描述。 |
| ResetAccountPassword | 调用ResetAccountPassword接口重置账号密码。 |
| ResetAccount | 调用ResetAccount接口重置高权限账号的权限。 |
安全加密
| API | 描述 |
|---|---|
| DescribeSecurityGroupConfiguration | 调用DescribeSecurityGroupConfiguration接口查看指定RDS实例和ECS安全组的关联信息。 |
| ModifySecurityGroupConfiguration | 调用ModifySecurityGroupConfiguration接口修改指定RDS实例和ECS安全组的关联信息。 |
| DescribeDBInstanceIPArrayList | 调用DescribeDBInstanceIPArrayList接口查看RDS实例IP白名单。 |
| DescribeDBInstanceSSL | 调用DescribeDBInstanceSSL接口查询实例SSL设置。 |
| DescribeDBInstanceTDE | 调用DescribeDBInstanceTDE接口查询实例数据加密状态。 |
| ModifyDBInstanceSSL | 调用ModifyDBInstanceSSL接口修改实例SSL链路。 |
| ModifyDBInstanceTDE | 调用ModifyDBInstanceTDE接口开启RDS实例透明数据加密功能。 |
| ModifySecurityIps | 调用ModifySecurityIps接口修改白名单。 |
| MigrateSecurityIPMode | 调用MigrateSecurityIPMode接口把白名单从通用模式切换为高安全模式。 |
| DescribeDBInstanceIpHostname | 调用DescribeDBInstanceIpHostname接口查询RDS实例的底层ECS实例的hostname。 |
| DescribeDTCSecurityIpHostsForSQLServer | 调用DescribeDTCSecurityIpHostsForSQLServer接口查询RDS实例的分布式事务白名单信息。 |
| ModifyDTCSecurityIpHostsForSQLServer | 调用ModifyDTCSecurityIpHostsForSQLServer接口设置分布式事务白名单。 |
网络
| API | 描述 |
|---|---|
| ModifyDBInstanceNetworkType | 调用ModifyDBInstanceNetworkType接口切换RDS实例网络类型。 |
日志
| API | 描述 |
|---|---|
| DescribeSlowLogs | 调用DescribeSlowLogs查看慢日志统计情况。 |
| DescribeSlowLogRecords | 调用DescribeSlowLogRecords接口查看实例的慢日志明细。 |
| DescribeErrorLogs | 调用DescribeErrorLogs接口查看实例某段时间内的错误日志。 |
| DescribeBinlogFiles | 调用DescribeBinlogFiles接口查看Binlog日志。 |
| ModifySQLCollectorPolicy | 调用ModifySQLCollectorPolicy接口开启或关闭实例的SQL洞察（SQL审计）功能。 |
| DescribeSQLLogRecords | 调用DescribeSQLLogRecords接口查询实例的SQL洞察（SQL审计）日志。 |
| DescribeSQLLogFiles | 调用DescribeSQLLogFiles接口查询SQL洞察（SQL审计）文件列表。 |
备份
| API | 描述 |
|---|---|
| CreateBackup | 调用CreateBackup接口为实例创建一个备份集。 |
| DescribeBackups | 调用DescribeBackups接口查看备份集列表。 |
| DescribeBackupPolicy | 调用DescribeBackupPolicy接口查看实例备份设置。 |
| ModifyBackupPolicy | 调用ModifyBackupPolicy接口修改备份设置。 |
| DeleteBackup | 调用DeleteBackup接口删除数据备份文件。 |
| DescribeBackupTasks | 调用DescribeBackupTasks接口查询实例的备份任务列表。 |
| DescribeLogBackupFiles | 调用DescribeLogBackupFiles接口查询实例的日志备份文件。 |
恢复
| API | 描述 |
|---|---|
| CloneDBInstance | 调用CloneDBInstance接口将历史数据恢复至一个新实例（称为克隆实例）。 |
| CreateTempDBInstance | 调用CreateTempDBInstance接口创建临时实例。 |
| RecoveryDBInstance | 调用RecoveryDBInstance接口恢复数据库。 |
| RestoreTable | 调用RestoreTable接口恢复RDS实例的某些数据库或表到原实例。 |
SQL Server备份文件上云
| API | 描述 |
|---|---|
| CreateMigrateTask | 调用CreateMigrateTask接口将OSS上的备份文件还原到RDS实例，实现数据上云。 |
| DescribeMigrateTasks | 调用DescribeMigrateTasks接口查询备份数据上云任务列表。 |
| DescribeOssDownloads | 调用DescribeOssDownloads接口查看备份数据上云任务的文件详情。 |
| CreateOnlineDatabaseTask | 在备份数据上云时调用CreateOnlineDatabaseTask接口打开数据库。 |
监控
| API | 描述 |
|---|---|
| DescribeResourceUsage | 调用DescribeResourceUsage接口查看实例的空间利用信息。 |
| DescribeDBInstancePerformance | 调用DescribeDBInstancePerformance接口查看实例性能数据。 |
| DescribeDBInstanceMonitor | 调用DescribeDBInstanceMonitor接口查询监控频率。 |
| ModifyDBInstanceMonitor | 调用ModifyDBInstanceMonitor修改监控频率。 |
参数
| API | 描述 |
|---|---|
| DescribeParameterTemplates | 调用DescribeParameterTemplates接口查看数据库参数模板。 |
| DescribeParameters | 调用DescribeParameters接口查询实例当前的参数配置。 |
| ModifyParameter | 调用ModifyParameter接口修改实例参数。 |
| CreateParameterGroup | 调用CreateParameterGroup接口创建RDS参数模板。 |
| ModifyParameterGroup | 调用ModifyParameterGroup接口修改RDS参数模板。 |
| CloneParameterGroup | 调用CloneParameterGroup接口复制RDS参数模板到当前地域或其他地域内。 |
| DescribeParameterGroups | 调用DescribeParameterGroups接口查询目标地域的参数模板列表。 |
| DescribeParameterGroup | 调用DescribeParameterGroup接口查询指定的RDS参数模板信息。 |
| DeleteParameterGroup | 调用DeleteParameterGroup接口删除RDS参数模板。 |
数据迁移
| API | 描述 |
|---|---|
| ImportDatabaseBetweenInstances | 调用ImportDatabaseBetweenInstances接口从其它RDS实例迁入数据。 |
| CancelImport | 调用CancelImport接口用于取消RDS实例迁移任务。 |
标签
| API | 描述 |
|---|---|
| TagResources | 调用TagResources为指定的RDS实例创建并绑定标签。 |
| UntagResources | 调用UntagResources为指定的RDS实例解绑标签。 |
| ListTagResources | 调用ListTagResources查询一个或多个RDS实例已经绑定的标签列表。 |
跨地域备份恢复
| API | 描述 |
|---|---|
| CheckCreateDdrDBInstance | 调用CheckCreateDdrDBInstance接口预检查某RDS实例是否可以用跨地域备份集进行跨地域恢复。 |
| CreateDdrInstance | 调用CreateDdrInstance接口跨地域恢复数据到新实例。 |
| ModifyInstanceCrossBackupPolicy | 调用ModifyInstanceCrossBackupPolicy接口修改RDS跨地域备份设置。 |
| DescribeInstanceCrossBackupPolicy | 调用DescribeInstanceCrossBackupPolicy接口查询跨地域备份设置。 |
| DescribeCrossRegionBackups | 调用DescribeCrossRegionBackups接口查看某RDS实例跨地域数据备份文件列表。 |
| DescribeCrossRegionLogBackupFiles | 调用DescribeCrossRegionLogBackupFiles接口查看跨地域日志备份文件列表。 |
| DescribeAvailableRecoveryTime | 调用DescribeAvailableRecoveryTime接口查询某跨地域备份文件可恢复哪个时间段的数据。 |
| DescribeCrossRegionBackupDBInstance | 调用DescribeCrossRegionBackupDBInstance接口查询所选地域的哪些实例开启了跨地域备份，以及这些实例的跨地域备份设置。 |
