AI 助理
备案控制台
官方文档
输入文档关键字查找
首页 云数据库 RDS RDS MariaDB数据库 开发参考 RDS MariaDB API参考 API概览

API概览

更新时间：
产品详情
我的收藏
本产品（云数据库 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实例手动续费。
DescribeDBInstancePromoteActivity查询实例命中的促销活动（停止维护）该接口已停止维护：可以正常调用，但不再维护。

实例

API标题API概述
CreateDBInstance创建RDS实例该接口用于创建RDS实例。
CreateDBInstanceForRebuild回收站重建实例该接口用于重建已进入回收站的实例。
DeleteDBInstance释放RDS实例该接口用于释放RDS实例。
RestartDBInstance重启RDS实例该接口用于手动重启RDS实例。
ModifyDBInstanceSpec变更RDS实例该接口用于变更RDS实例的规格和存储空间等。
DestroyDBInstance销毁实例该接口用于销毁回收站中的RDS实例。
ModifyDBInstanceDescription修改实例名称该接口用于修改RDS实例的名称。
ModifyDBInstanceMaintainTime修改实例可维护时间段该接口用于修改RDS实例的可维护时间段。
ModifyResourceGroup修改实例资源组该接口用于将RDS实例移动到指定资源组。
ModifyHADiagnoseConfig修改实例可用性检测方式该接口用于修改RDS实例的可用性检测方式。
DescribeSupportOnlineResizeDisk查询实例是否支持在线扩盘该接口用于查询RDS SQL Server实例是否支持在线扩盘。
DescribeAvailableZones查询可用区资源该接口用于查询RDS的可用区资源。
DescribeAvailableClasses查询实例可变更规格该接口用于查询RDS实例的可变更规格及存储空间等信息。
DescribeDBInstanceAttribute查询实例详情该接口用于查询RDS实例的详细信息。
DescribeDBInstances查询实例列表该接口用于查询RDS的实例列表。
ListClasses查询规格信息该接口用于查询RDS实例所有规格的详情。
DescribeDBInstancesByExpireTime按过期时间获取数据库实例该接口用于通过包年包月实例的剩余可用时间查询RDS实例信息。
DescribeRegions查看可选的地域和可用区该接口用于查询所有RDS地域和可用区详情（包含已裁撤地域，请谨慎使用）。
CheckInstanceExist查询实例是否存在该接口用于查询目标RDS实例是否存在。
DescribeHADiagnoseConfig查询实例可用性检测方式该接口用于查询RDS实例的可用性检测方式。
DescribeAnalyticdbByPrimaryDBInstance查询RDS MySQL分析实例数量该接口用于查询RDS MySQL实例关联的分析型实例数量。
CheckCloudResourceAuthorized查询RDS实例的授权状态该接口用于查询RDS实例的权限状态。
ReleaseInstanceConnection释放实例外网连接地址该接口用于释放RDS实例的外网连接地址。
DescribeDBInstanceDetail获取RDS SQL Server实例详细信息该接口用于查询RDS SQL Server实例详情。
DescribeDBInstancesByPerformance按性能获取数据库实例该接口用于按性能查询数据库实例。
DescribeDBInstancesForClone查看克隆数据库实例（停止维护）该接口用于查看克隆数据库实例。已停止维护：可以正常调用，但不再维护。
DescribeDBInstancesAsCsv按CSV文件格式查询实例列表（停止维护）该接口用于查询实例列表。 已停止维护：可以正常调用，但不再维护。

网络与连接地址

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

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

API标题API概述
ModifyHASwitchConfig开启或关闭RDS实例的主备自动切换功能该接口用于开启或关闭RDS实例的主备自动切换功能。
DescribeDBInstanceHAConfig查询RDS实例高可用模式和数据复制方式该接口用于查询RDS实例的高可用模式和数据复制方式。
DescribeHASwitchConfig查询RDS实例主备自动切换设置该接口用于查询RDS实例主备自动切换的设置。
SwitchDBInstanceHARDS实例主备切换该接口用于RDS实例的手动主备切换。

历史事件

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

通知

API标题API概述
QueryNotify查询通知该接口用于查询RDS的通知。
ConfirmNotify确认通知该接口用于确认主账号下RDS控制台的轮播消息。
DescribeRdsResourceSettings获取RDS资源设置（停止维护）该接口用于获取实例资源的通知设置信息，已停止维护：可以正常调用，但不再维护。

账号

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

数据库

API标题API概述
CreateDatabase创建数据库该接口用于在RDS实例下创建数据库。
DeleteDatabase删除数据库该接口用于删除RDS实例中指定数据库。
CopyDatabase复制数据库复制数据库SQL Server 2008 R2版。
ModifyDBDescription修改数据库备注说明该接口用于修改数据库的备注。
DescribeDatabases查看实例下的数据库信息该接口用于查询RDS实例下的数据库信息。
DescribeCollationTimeZones查询RDS SQL Server支持的字符集排序规则和时区该接口用于查询RDS SQL Server支持的字符集排序规则和时区。
DescribeCharacterSetName查看数据库支持的字符集列表该接口用于查询RDS实例支持的字符集。
CopyDatabaseBetweenInstancesRDS SQL Server实例间复制数据库该接口用于在RDS SQL Server实例间复制数据库。
CheckDBNameAvailable检查数据库名称是否可用该接口用于检查数据库名称是否重复或不符合命名规范。

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

API标题API概述
DescribeDBInstanceProxyConfiguration查看数据库代理设置该接口用于查看RDS MySQL数据库代理设置。
AllocateReadWriteSplittingConnection申请只读地址该接口用于申请只读地址。
CalculateDBInstanceWeight查询系统权重分配值该接口用于查询系统权重分配值。

安全加密

API标题API概述
AttachWhitelistTemplateToInstance关联白名单模板到实例该接口用于将白名单模板关联到实例。
CreateServiceLinkedRole创建服务关联角色（SLR）该接口用于创建服务关联角色（SLR）。
DetachWhitelistTemplateToInstance取消关联白名单模板与实例该接口用于取消关联的白名单模板与实例。
DescribeSecurityGroupConfiguration查询RDS实例和ECS安全组关联信息该接口用于查询指定RDS实例和ECS安全组的关联信息。
CreateDBInstanceSecurityGroupRule添加安全组规则该接口用于为RDS SQL Server实例添加安全组规则。
DescribeDBInstanceSecurityGroupRule查看安全组规则该接口用于查询RDS SQL Server实例的安全组规则。
DeleteDBInstanceSecurityGroupRule删除安全组规则该接口用于删除RDS SQL Server实例已设置的安全组规则。
ModifySecurityIps修改RDS实例IP白名单修改指定RDS实例的IP白名单配置，支持覆盖、追加、删除三种修改模式。
ModifyDBInstanceDeletionProtection开启或关闭实例释放保护该接口用于开启或关闭RDS实例的释放保护功能。
DescribeWhitelistTemplateLinkedInstance查询白名单模板关联实例该接口用于根据白名单模板查询关联的实例。
DescribeInstanceLinkedWhitelistTemplate查询实例关联的白名单模板该接口用于根据实例的名称查询关联的白名单模板。
DescribeWhitelistTemplate查询白名单模板信息该接口用于获取指定的白名单模板信息。
DescribeAllWhitelistTemplate批量查询白名单模板信息该接口用于批量获取白名单模板，支持模糊查询。
DescribeDBInstanceIPArrayList查看RDS实例IP白名单该接口用于查询RDS实例的IP白名单。
DescribeDBInstanceSSL查询RDS实例的SSL配置该接口用于查询RDS实例的SSL配置情况。
DescribeDBInstanceTDE查询RDS实例透明数据加密TDE状态该接口用于查询RDS实例的透明数据加密TDE的加密状态。
DescribeDBInstanceEncryptionKey查询云盘加密状态及密钥详情查询RDS实例是否开启了云盘加密，以及密钥详情。
DescribeDBInstanceIpHostname查询RDS SQL Server实例底层ECS实例的IpHostnameInfos信息该接口用于查询RDS SQL Server实例底层所在ECS实例的内网IP和ECS主机名。
DescribeDTCSecurityIpHostsForSQLServer查询RDS实例的分布式事务白名单信息该接口用于查询RDS SQL Server实例的分布式事务白名单信息。

日志

API标题API概述
DescribeSQLLogReportList获取SQL日志报告列表该接口用于查看SQL日志运行报告列表。
DescribeSQLLogFiles查询SQL洞察（SQL审计）导出文件列表该接口用于查询SQL洞察（SQL审计）导出文件列表。不支持查询通过控制台手动导出的SQL洞察日志文件，只支持查询通过DescribeSQLLogRecords接口生成（请求参数Form取值为File）的SQL洞察文件列表。
DescribeSlowLogs查看慢日志统计情况该接口用于查询慢日志统计情况。
DescribeSlowLogRecords查看慢日志明细该接口用于查看实例的慢日志明细。
DescribeErrorLogs查看错误日志该接口查询实例某段时间内的错误日志。
DescribeSQLCollectorPolicy查询实例的SQL审计功能是否开启（停止维护）停止维护：可以正常调用，但不再维护。该接口用于查询RDS实例的SQL洞察（SQL审计）功能是否开启。
DescribeSQLLogRecords查询实例的SQL审计日志（停止维护）停止维护：可以正常调用，但不再维护。该接口用于查询RDS实例的SQL洞察（SQL审计）日志。
DescribeSQLCollectorRetention查询RDS实例的SQL洞察日志保存时长（停止维护）停止维护：可以正常调用，但不再维护。该接口用于查询RDS实例的SQL洞察日志保存时长。

备份

API标题API概述
CreateBackup为RDS实例创建备份集该接口用于为RDS实例创建一个备份集。
DeleteBackup删除实例数据备份文件该接口用于删除RDS实例的数据备份文件。
DeleteBackupFile删除SQL Server备份文件该接口用于删除RDS SQL Server的备份文件。新用户不支持使用该接口，此前已加白用户仍可正常使用。
ModifyBackupPolicy修改实例备份策略该接口用于修改RDS实例的备份策略设置。
DescribeBackups查看RDS实例备份集列表该接口用于查看RDS实例的备份集列表。
DescribeDetachedBackups查询已被释放的RDS MySQL实例中备份集列表该接口用于查看已被释放的RDS MySQL实例的备份集列表。
DescribeBackupPolicy查看实例备份设置该接口用于查询RDS实例的备份设置。
DescribeBackupTasks查询实例的备份任务列表该接口用于查询RDS实例的备份任务列表。
DescribeBinlogFiles查看RDS实例的日志（Binglog/Wal）文件该接口用于查询RDS MySQL/RDS MariaDB实例的Binlog日志或RDS PostgreSQL实例的Wal日志。
DescribeLogBackupFiles查询实例的日志备份文件该接口用于查询RDS SQL Server实例的日志备份文件。
DescribeBackupDatabase查询备份集数据库列表查询备份集下的数据库列表。

恢复

API标题API概述
CreateTempDBInstance创建临时实例该接口用于为RDS SQL Server 2008 R2高性能本地盘实例创建临时实例。
DescribeLocalAvailableRecoveryTime查询RDS实例备份可恢复的时间范围该接口用于查询RDS实例备份可恢复的时间范围。
DescribeMetaList查询备份集的库表信息该接口用于查询目标备份集中可恢复的库表信息。
CloneDBInstance恢复数据（克隆实例）该接口用于将历史数据恢复至一个新实例（称为克隆实例）。

跨地域备份恢复

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

监控

API标题API概述
DescribeResourceUsage查看实例的空间利用信息该接口用于查询RDS实例的空间使用信息。
DescribeDBInstancePerformance查询实例性能数据该接口用于查询实例性能数据。
DescribeDBInstanceMonitor查询监控频率该接口用于查询监控频率。
DescribeAvailableMetrics查询RDS PostgreSQL的所有监控指标项该接口用于获取RDS PostgreSQL实例支持的所有增强监控指标。
DescribeDBInstanceMetrics查询RDS PostgreSQL实例展示的监控指标项该接口用于查询RDS PostgreSQL实例已开启展示的增强指标。

参数

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

数据迁移

API标题API概述
DescibeImportsFromDatabase查看实例迁移状态列表该接口用于查看实例迁移状态列表。

运维任务管理

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

标签

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

其他

API标题API概述
用户凭证用户凭证
CreateSecret创建用户凭证该接口用于创建Data API用户凭证。
DeleteSecret删除用户凭证调用DeleteSecret接口删除Data API用户凭证。
DescribeSecrets查询用户凭证该接口用于查询Data API用户凭证。
主机主机
DescribeDedicatedHostGroups查询RDS主机组信息查询RDS专属集群信息。
DescribeDedicatedHosts查询RDS主机组内的主机信息查询专属集群内的主机信息。
MigrateDBInstance迁移主机组内的RDS实例调用MigrateDBInstance接口迁移专属集群内的RDS实例。
RebuildDBInstance将RDS主机组内实例的备实例重建调用RebuildDBInstance接口重建专属集群中的RDS备实例。
CheckServiceLinkedRole查询是否已创建服务关联角色（SLR）该接口用于查看是否已创建服务关联角色（SLR）。
DescribeDBMiniEngineVersions查询可使用的内核版本列表该接口用于查询可用的MySQL或PostgreSQL小版本列表。
DescribeRegionInfos查询可见地域列表该接口用于获取地域列表。
DescribeDBInstanceNetInfoForChannel查询实例网络信息该接口用于查询RDS实例的所有连接地址信息。
DescribeHostWebShell查询RDS SQL Server实例的主机WebShell登录信息该接口用于查询RDS SQL Server实例的主机WebShell登录信息。
DescribeClassDetails查询规格详情该接口用于通过规格代码查询规格详情。
DescribeKmsAssociateResources查询KMS指定资源是否关联RDS实例该接口用于查询KMS的指定资源是否关联了RDS实例。
ModifyDBInstanceReplicationSwitch修改实例原生复制开关状态调用ModifyDBInstanceReplicationSwitch接口开启或关闭RDS原生复制模式。
DescribeDBInstanceReplication查询实例复制状态该接口用于查询原生复制实例状态与配置。
MigrateDBNodes迁移RDS实例节点该接口用于变更RDS MySQL集群系列实例节点可用区。
SwitchOverMajorVersionUpgrade大版本升级切换用于RDS PostgreSQL的零停机大版本升级流量切换。

事件与任务

API标题API概述
DescribeHistoryEventsStat查询统计历史事件统计事件中心的历史事件。
DescribeHistoryEvents查询历史事件查询事件中心的事件列表。
DescribeHistoryTasksStat统计历史任务统计任务中心的任务。
DescribeHistoryTasks查询历史运维任务该接口用于获取历史任务记录，支持创建时间30天内的任务。
DescribeTasks查询RDS SQL Server任务详情该接口用于查询RDS SQL Server实例中处于等待中和执行中的任务。

控制台接口

API标题API概述
CreateYouhuiForOrder领取优惠券该接口用于领取优惠券。
DescribeCurrentModifyOrder查询实例最新变配订单
DescribeCustinsResourceInfo查询实例资源使用情况查询实例资源使用情况
DescribeDBInstanceConnectivity查询数据库实例连接获取实例链路诊断信息
DescribeHostGroupElasticStrategyParameters查询主机组弹性策略配置
DescribeMarketingActivity查询营销活动获取RDS营销项目中待升级实例信息
DescribeQuickSaleConfig查询快捷售卖商品配置查询RDS快捷售卖配置
DescribeResourceDetails查询资源详细信息概览页资源详情
EvaluateLocalExtendDisk评估本地扩展磁盘
ModifyCustinsResource修改实例资源该接口用于修改RDS实例资源。
PreCheckCreateOrderForDeleteDBNodes删除实例节点预检查
QueryRecommendByCode查询RDS热点问题该接口用于查询RDS机器人热点问题。
CreateOrderForDeleteDBNodes删除实例节点该接口用于为RDS MySQL集群系列实例删除节点。
上一篇：RDS MariaDB API参考下一篇：服务接入点