云数据库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实例。 |
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实例可维护时间段。 |
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历史事件功能。 |
账号
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 | 描述 |
---|---|
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实例迁移任务。 |
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 | 描述 |
---|---|
TagResources | 为指定的RDS实例创建并绑定标签。 |
UntagResources | 为指定的RDS实例解绑标签。 |
ListTagResources | 查询一个或多个RDS实例已经绑定的标签列表。 |