API概览_云数据库 RDS(RDS)-阿里云帮助中心

本产品（云数据库 RDS/2014-08-15）的OpenAPI采用RPC签名风格，签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（78410016550），在专家指导下进行签名对接。

在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见获取AccessKey。

费用

API	标题	API概述
TransformDBInstancePayType	变更RDS实例的计费方式	该接口用于变更RDS实例的计费方式。
ModifyDBInstancePayType	按量付费实例转包年包月	该接口用于将按量付费实例变更为包年包月实例。
ModifyInstanceAutoRenewalAttribute	修改RDS实例的自动续费设置	该接口用于修改RDS实例的自动续费设置。
DescribePrice	查询实例的价格	该接口用于查询RDS实例的价格信息。
DescribeRenewalPrice	查询RDS实例续费的费用	该接口用于查询包年包月RDS实例续费的费用。
DescribeInstanceAutoRenewalAttribute	查询RDS实例自动续费情况	该接口用于查询RDS实例自动续费情况。
RenewInstance	手动续费RDS实例	该接口用于为RDS实例手动续费。

实例

API	标题	API概述
CreateDBInstance	创建一个RDS实例	该接口用于创建RDS实例。
CreateDBInstanceForRebuild	回收站重建实例	该接口用于重建已进入回收站的实例。
DeleteDBInstance	释放RDS实例	该接口用于释放RDS实例。
RestartDBInstance	重启RDS实例	该接口用于手动重启RDS实例。
ModifyDBInstanceSpec	变更RDS实例	该接口用于变更RDS实例的规格和存储空间等。
ModifyDBInstanceDescription	修改实例名称	该接口用于修改RDS实例的名称。
ModifyDBInstanceMaintainTime	修改实例可维护时间段	该接口用于修改RDS实例的可维护时间段。
ModifyResourceGroup	修改实例资源组	该接口用于将RDS实例移动到指定资源组。
ModifyHADiagnoseConfig	修改实例可用性检测方式	该接口用于修改RDS实例的可用性检测方式。
DescribeAvailableZones	查询可用区资源	该接口用于查询RDS的可用区资源。
DescribeAvailableClasses	查询实例可变更规格	该接口用于查询RDS实例的可变更规格及存储空间等信息。
DescribeDBInstanceAttribute	查询实例详情	该接口用于查询RDS实例的详细信息。
DescribeDBInstances	查询实例列表	该接口用于查询RDS的实例列表。
ListClasses	查询规格信息	该接口用于查询RDS实例所有规格的详情。
DescribeDBInstancesByExpireTime	按过期时间获取数据库实例	该接口用于通过包年包月实例的剩余可用时间查询RDS实例信息。
DescribeRegions	查看可选的地域和可用区	该接口用于查询所有RDS地域和可用区详情（包含已裁撤地域，请谨慎使用）。
CheckInstanceExist	查询实例是否存在	该接口用于查询目标RDS实例是否存在。
DescribeHADiagnoseConfig	查询实例可用性检测方式	该接口用于查询RDS实例的可用性检测方式。
CheckCloudResourceAuthorized	查询RDS实例的授权状态	该接口用于查询RDS实例的权限状态。
ReleaseInstanceConnection	释放实例外网连接地址	该接口用于释放RDS实例的外网连接地址。

网络与连接地址

API	标题	API概述
AllocateInstancePublicConnection	申请外网连接地址	该接口用于为RDS实例申请外网连接地址。
ReleaseInstancePublicConnection	释放实例的外网连接地址	该接口用于释放实例的外网连接地址。
ModifyDBInstanceConnectionString	修改实例的连接地址和端口	该接口用于修改实例的连接地址和端口。
DescribeDBInstanceNetInfo	查询实例的所有连接地址信息	该接口用于查询RDS实例的所有连接地址信息。
DescribeVSwitches	查询虚拟交换机列表	该接口用于查询专有网络VPC下虚拟交换机的详细信息。

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

API	标题	API概述
ModifyHASwitchConfig	开启或关闭RDS实例的主备自动切换功能	该接口用于开启或关闭RDS实例的主备自动切换功能。
DescribeHASwitchConfig	查询RDS实例主备自动切换设置	该接口用于查询RDS实例主备自动切换的设置。
SwitchDBInstanceHA	RDS实例主备切换	该接口用于RDS实例的手动主备切换。

历史事件

API	标题	API概述
ModifyActionEventPolicy	开关历史事件	该接口用于开启或关闭RDS的历史事件功能。
DescribeEvents	查询历史事件	该接口用于查询RDS历史事件记录列表。
DescribeActionEventPolicy	查询RDS历史事件功能是否开启	该接口用于查询RDS的历史事件功能是否开启。

通知

API	标题	API概述
QueryNotify	查询通知	该接口用于查询RDS的通知。
ConfirmNotify	确认通知	该接口用于确认主账号下RDS控制台的轮播消息。

账号

API	标题	API概述
CreateAccount	创建数据库账号	该接口用于创建数据库账号。
DeleteAccount	删除数据库账号	该接口用于删除数据库账号。
ModifyAccountDescription	修改数据库账号的备注信息	该接口用于修改数据库账号的描述信息。
DescribeAccounts	查询数据库账号信息	该接口用于查询RDS实例的账号信息。
DescribeInstanceKeywords	获取实例的保留关键词信息	该接口用于查询RDS实例的保留关键字，即创建数据库或账号时禁用的关键字。
ResetAccountPassword	重置数据库账号的密码	该接口用于重置数据库账号的密码。
GrantAccountPrivilege	授权账号访问数据库	该接口用于授权数据库账号访问指定的数据库。
RevokeAccountPrivilege	撤销账号对数据库的访问权限	该接口用于撤销账号对数据库的访问权限。
ResetAccount	重置高权限账号权限	该接口用于重置高权限账号的权限。
CheckAccountNameAvailable	检查账号名称是否可用	该接口用于检查目标需要创建的账号名称是否可用。

数据库

API	标题	API概述
CreateDatabase	创建数据库	该接口用于在RDS实例下创建数据库。
DeleteDatabase	删除数据库	该接口用于删除RDS实例下的指定数据库。
ModifyDBDescription	修改数据库备注说明	该接口用于修改数据库的备注。
DescribeDatabases	查看实例下的数据库信息	该接口用于查询RDS实例下的数据库信息。
DescribeCharacterSetName	查看数据库支持的字符集列表	该接口用于查询RDS实例支持的字符集。
CheckDBNameAvailable	检查数据库名称是否可用	该接口用于检查数据库名称是否重复或不符合命名规范。

安全加密

API	标题	API概述
ModifySecurityIps	修改RDS实例IP白名单	该接口用于修改RDS实例的IP白名单。
ModifyDBInstanceDeletionProtection	开启或关闭实例释放保护	该接口用于开启或关闭RDS实例的释放保护功能。
DescribeDBInstanceIPArrayList	查看RDS实例IP白名单	该接口用于查询RDS实例的IP白名单。

日志

API	标题	API概述
DescribeSlowLogs	查看慢日志统计情况	该接口用于查询慢日志统计情况。
DescribeSlowLogRecords	查看慢日志明细	该接口用于查看实例的慢日志明细。
DescribeErrorLogs	查看错误日志	该接口查询实例某段时间内的错误日志。
DescribeSQLLogReportList	获取SQL日志报告列表	该接口用于查看SQL日志运行报告列表。

备份

API	标题	API概述
CreateBackup	为RDS实例创建备份集	该接口用于为RDS实例创建一个备份集。
ModifyBackupPolicy	修改实例备份策略	该接口用于修改RDS实例的备份策略设置。
DescribeBackups	查看RDS实例备份集列表	该接口用于查看RDS实例的备份集列表。
DescribeBackupPolicy	查看实例备份设置	该接口用于查询RDS实例的备份设置。
DescribeBackupTasks	查询实例的备份任务列表	该接口用于查询RDS实例的备份任务列表。
DescribeBinlogFiles	查看RDS实例的日志（Binglog/Wal）文件	该接口用于查询RDS MySQL/RDS MariaDB实例的Binlog日志或RDS PostgreSQL实例的Wal日志。

恢复

API	标题	API概述
DescribeLocalAvailableRecoveryTime	查询RDS实例备份可恢复的时间范围	该接口用于查询RDS实例备份可恢复的时间范围。
CloneDBInstance	恢复数据（克隆实例）	该接口用于将历史数据恢复至一个新实例（称为克隆实例）。

监控

API	标题	API概述
DescribeResourceUsage	查看实例的空间利用信息	该接口用于查询RDS实例的空间使用信息。
DescribeDBInstancePerformance	查询实例性能数据	该接口用于查询实例性能数据。
DescribeDBInstanceMonitor	查询监控频率	该接口用于查询监控频率。

参数

API	标题	API概述
ModifyParameter	修改实例参数	该接口用于修改RDS实例的参数值。
DescribeParameters	查询实例当前的参数配置	该接口用于查询实例当前的参数配置。
DescribeModifyParameterLog	查询RDS实例的参数修改日志	该接口用于查询RDS实例的参数修改日志。
DescribeParameterTemplates	查看参数模板详情列表	该接口用于查询数据库参数模板。

运维任务管理

API	标题	API概述
ModifyActiveOperationTasks	修改多个主动运维任务切换时间	该接口用于修改RDS实例计划内运维任务的切换时间。
DescribeActiveOperationTasks	查询多个主动运维任务信息	该接口用于查看RDS实例的计划内运维任务详情。
CancelActiveOperationTasks	取消主动运维任务	该接口用于取消尚未开始的运维任务。

API	标题	API概述
TagResources	创建标签	该接口用于为指定的RDS实例创建并绑定标签。
AddTagsToResource	为实例绑定标签	该接口用于为实例绑定标签。
UntagResources	解绑标签	该接口用于为指定的RDS实例解绑标签。
RemoveTagsFromResource	为RDS实例解绑标签	该接口用于解绑标签。
ListTagResources	查询标签和资源列表	该接口用于查询一个或多个RDS实例已经绑定的标签列表。
DescribeTags	查询标签列表	该接口用于查询RDS实例的标签信息。
DescribeDBInstanceByTags	查询实例标签信息	该接口用于获取实例绑定的标签信息。

其他

API	标题	API概述
DescribeRegionInfos	查询可见地域列表	该接口用于获取地域列表。
DescribeDBInstanceNetInfoForChannel	查询实例网络信息	该接口用于查询RDS实例的所有连接地址信息。
DescribeClassDetails	查询规格详情	该接口用于通过规格代码查询规格详情。
DescribeKmsAssociateResources	查询KMS指定资源是否关联RDS实例	该接口用于查询KMS的指定资源是否关联了RDS实例。
DeleteReplicationLink	删除灾备实例的数据同步链路并将其提升为主实例	该接口用于删除RDS灾备实例的数据同步链路，并将其提升为主实例。
DescribeReplicationLinkLogs	查询RDS实例数据同步链路的操作日志	该接口用于查询指定RDS实例数据同步链路的操作日志。
CreateReplicationLink	创建灾备实例	该接口用于为RDS实例创建灾备实例，并配置数据同步链路。
RebuildReplicationLink	为灾备实例重建数据同步链路	该接口用于为RDS灾备实例重建数据同步链路。

停止维护的接口

API	标题	API概述
数据库性能优化	数据库性能优化
DescribeDiagnosticReportList	查询诊断报告列表	该接口用于查询诊断报告列表。
DestroyDBInstance	销毁实例	该接口用于销毁回收站中的RDS实例。
DescribeTasks	查询迁移结果	调用DescribeTasks接口查询RDS实例正在进行中的任务。
DescribeDBInstancesForClone	获取克隆数据库实例	调用DescribeDBInstancesForClone查看实例列表。
DescribeDBInstancesByPerformance	按性能获取数据库实例	调用DescribeDBInstancesByPerformance接口查询实例性能。
DescribeDBInstanceDetail	获取数据库实例详细信息	调用DescribeDBInstanceDetail接口查询实例详情。
DescribeRdsResourceSettings	获取RDS资源设置	此API已废弃，不再使用。
DescribeDBInstancesAsCsv	按CSV文件格式查询实例列表	该接口用于查询实例列表。
DescribeDBInstancePromoteActivity	查询实例命中的促销活动	该接口已下线，暂无法使用。
DescribeBackupDatabase	查询备份集数据库列表	查询备份集下的数据库列表，已下线。
CopyDatabase	复制数据库	复制数据库SQL Server 2008 R2版，已下线。

费用

实例