API概览

更新时间:
复制为 MD 格式

API标准及多语言预置SDK

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

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

自定义签名场景

若您的业务场景有特殊需求,需通过自签名方式对接 API,建议优先咨询我们的技术支持团队(服务钉钉群:147535001692),获取专业指导以确保高效接入。

账号与安全准备

阿里云账号具备对所有资源的完全管理权限。一旦 AccessKey 泄露,所有相关资源都将面临未经授权访问的风险。为确保安全,建议创建一个仅具备 API 访问权限的RAM用户并配置其 AccessKey,同时基于最小权限原则 (PoLP) 配置 RAM 策略。仅在明确需要阿里云账号权限的特定场景下,才使用阿里云账号。

费用

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实例。
StopDBInstance 暂停RDS实例 该接口用于暂停RDS实例。
StartDBInstance 启动RDS实例 该接口用于启动暂停的RDS实例。
ModifyDBInstanceSpec 变更RDS实例 该接口用于变更RDS实例的规格和存储空间等。
DestroyDBInstance 销毁实例 该接口用于销毁回收站中的RDS实例。
ModifyDasInstanceConfig 设置存储空间自动扩容 该接口用于设置RDS实例的存储空间自动扩容功能。
MigrateToOtherZone 迁移RDS实例可用区 该接口用于迁移RDS实例的可用区。
ModifyDBInstanceDescription 修改实例名称 该接口用于修改RDS实例的名称。
ModifyDBInstanceMaintainTime 修改实例可维护时间段 该接口用于修改RDS实例的可维护时间段。
ModifyResourceGroup 修改实例资源组 该接口用于将RDS实例移动到指定资源组。
ModifyHADiagnoseConfig 修改实例可用性检测方式 该接口用于修改RDS实例的可用性检测方式。
ModifyAccountSecurityPolicy 设置SQL Server账号密码策略 该接口用于修改RDS SQL Server实例的账号密码策略。
DescribeSupportOnlineResizeDisk 查询实例是否支持在线扩盘 该接口用于查询RDS SQL Server实例是否支持在线扩盘。
DescribeAvailableZones 查询可用区资源 该接口用于查询RDS的可用区资源。
DescribeAvailableClasses 查询实例可变更规格 该接口用于查询RDS实例的可变更规格及存储空间等信息。
DescribeDBInstanceAttribute 查询实例详情 该接口用于查询RDS实例的详细信息。
GetDBInstanceTopology 查询实例拓扑信息 该接口用于查看RDS实例的拓扑结构。
DescribeDBInstances 查询实例列表 该接口用于查询RDS的实例列表。
ListClasses 查询规格信息 该接口用于查询RDS实例所有规格的详情。
DescribeDBInstancesByExpireTime 按过期时间获取数据库实例 该接口用于通过包年包月实例的剩余可用时间查询RDS实例信息。
DescribeRegions 查看可选的地域和可用区 该接口用于查询所有RDS地域和可用区详情(包含已裁撤地域,请谨慎使用)。
CheckInstanceExist 查询实例是否存在 该接口用于查询目标RDS实例是否存在。
DescribeHADiagnoseConfig 查询实例可用性检测方式 该接口用于查询RDS实例的可用性检测方式。
CheckCloudResourceAuthorized 查询RDS实例的授权状态 该接口用于查询RDS实例的权限状态。
ReleaseInstanceConnection 释放实例外网连接地址 该接口用于释放RDS实例的外网连接地址。
DescribeDBInstanceDetail 获取RDS SQL Server实例详细信息 该接口用于查询RDS SQL Server实例详情。
DescribeDBInstancesByPerformance 按性能获取数据库实例 该接口用于按性能查询数据库实例。
DescribeDBInstancesForClone 查看克隆数据库实例(停止维护) 该接口用于查看克隆数据库实例。已停止维护:可以正常调用,但不再维护。
DescribeDBInstancesAsCsv CSV文件格式查询实例列表(停止维护) 该接口用于查询实例列表。 已停止维护:可以正常调用,但不再维护。

升级版本

API

标题

API概述

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

网络与连接地址

API

标题

API概述

AllocateInstancePublicConnection 申请外网连接地址 该接口用于为RDS实例申请外网连接地址。
ReleaseInstancePublicConnection 释放实例的外网连接地址 该接口用于释放实例的外网连接地址。
ModifyDBInstanceConnectionString 管理实例的连接地址和端口 该接口用于管理实例的连接地址和端口。
ModifyDBInstanceNetworkExpireTime 修改混访模式下经典网络地址过期时间 该接口用于修改混访模式下经典网络地址的过期时间。
SwitchDBInstanceNetType 切换经典网络内外网地址 该接口用于切换经典网络实例的内外网地址。
ModifyDBInstanceNetworkType 经典网络切换为VPC网络 该接口用于将经典网络的RDS实例切换为VPC网络。
SwitchDBInstanceVpc 切换RDS实例的VPC和交换机 该接口用于切换RDS实例的专有网络VPC和交换机。
ModifyDBInstanceConfig 修改RDS实例的配置项 该接口用于修改RDS实例的配置项。
DescribeDBInstanceNetInfo 查询实例的所有连接地址信息 该接口用于查询RDS实例的所有连接地址信息。
DescribeVSwitches 查询虚拟交换机列表 该接口用于查询专有网络VPC下虚拟交换机的详细信息。

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

API

标题

API概述

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

历史事件

API

标题

API概述

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

通知

API

标题

API概述

QueryNotify 查询通知 该接口用于查询RDS的通知。
ConfirmNotify 确认通知 该接口用于确认主账号下RDS控制台的轮播消息。
DescribeRdsResourceSettings 获取RDS资源设置(停止维护) 该接口用于获取实例资源的通知设置信息,已停止维护:可以正常调用,但不再维护。

账号

API

标题

API概述

CreateAccount 创建数据库账号 该接口用于创建数据库账号。
DeleteAccount 删除数据库账号 该接口用于删除数据库账号。
ModifyAccountCheckPolicy 修改SQL Server账号密码策略 该接口用于修改RDS SQL Server数据库的账号密码策略。
ModifyAccountDescription 修改数据库账号的备注信息 该接口用于修改数据库账号的描述信息。
ModifyPGHbaConfig 修改RDS PostgreSQL实例pg_hba.conf文件配置 该接口用于修改RDS PostgreSQL实例的pg_hba.conf文件配置。
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 重置数据库账号的密码 该接口用于重置数据库账号的密码。
LockAccount 锁定RDS PostgreSQL数据库账号 该接口用于锁定RDS PostgreSQL实例的数据库账号。
UnlockAccount 解锁RDS PostgreSQL数据库账号 该接口用于解锁RDS PostgreSQL实例的数据库账号。
GrantAccountPrivilege 授权账号访问数据库 该接口用于授予指定数据库账号对单个或多个数据库的访问权限。
GrantOperatorPermission 授权服务账号 该接口用于授权服务账号。
RevokeOperatorPermission 撤销服务账号权限 该接口用于撤销阿里云服务账号对RDS实例的访问权限。
RevokeAccountPrivilege 撤销账号对数据库的访问权限 该接口用于撤销账号对数据库的访问权限。
ResetAccount 重置高权限账号权限 该接口用于重置高权限账号的权限。
CheckAccountNameAvailable 检查账号名称是否可用 该接口用于检查目标需要创建的账号名称是否可用。

数据库

API

标题

API概述

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

只读实例

API

标题

API概述

CreateReadOnlyDBInstance 创建只读实例 该接口用于为RDS实例创建一个只读实例。
ModifyReadonlyInstanceDelayReplicationTime 修改RDS MySQL只读实例的延迟复制时间 该接口用于修改RDS MySQL只读实例的延迟复制时间。
DescribeReadDBInstanceDelay 查询RDS只读实例的延迟信息 该接口用于查询RDS只读实例的延迟信息。
PrecheckDuckDBDependency 检查创建DuckDB分析实例前提条件 该接口用于检查RDS PostgreSQL主实例是否满足创建DuckDB分析实例的前提条件。对于不满足的条件将返回失败原因,并提供解决方案或建议的目标值。

RDS集群系列实例

API

标题

API概述

CreateDBNodes 创建节点 该接口用于为RDS集群系列实例新增节点。
CreateDBInstanceEndpoint 创建实例的Endpoint 该接口用于为RDS集群系列实例创建Endpoint。
CreateDBInstanceEndpointAddress 创建Endpoint外网连接地址 该接口用于为RDS集群系列实例创建Endpoint的外网连接地址。
DeleteDBNodes 删除节点 该接口用于为RDS集群系列实例删除节点。
DeleteDBInstanceEndpoint 删除实例的Endpoint 该接口用于删除RDS集群系列实例的Endpoint。
DeleteDBInstanceEndpointAddress 释放Endpoint外网连接地址 该接口用于释放RDS集群系列实例的Endpoint的外网连接地址。
ModifyDBInstanceEndpoint 修改实例的Endpoint权重信息 该接口用于修改RDS集群系列实例的Endpoint权重信息。
ModifyDBInstanceEndpointAddress 修改实例的Endpoint连接地址信息 该接口用于修改RDS集群系列实例的Endpoint连接地址信息。
DescribeDBInstanceEndpoints 查询实例Endpoint信息 该接口用于查询RDS集群系列实例的Endpoint信息。

数据库代理

API

标题

API概述

CreateDBProxyEndpointAddress 新增数据库代理的连接地址 该接口用于新增RDS实例数据库代理的连接地址。
DeleteDBProxyEndpointAddress 删除数据库代理连接地址 该接口用于删除RDS实例数据库代理的连接地址。
ModifyDBProxy 开通或修改数据库代理实例功能 该接口用于开启或者修改RDS实例的数据库代理实例功能。
UpgradeDBProxyInstanceKernelVersion 升级数据库代理内核小版本 该接口用于升级数据库代理的内核小版本。
ModifyDBProxyInstance 变更数据库代理实例配置 该接口用于变更RDS数据库代理实例相关配置。
ModifyDBProxyEndpoint 配置数据库代理连接地址访问策略 该接口用于配置RDS实例数据库代理连接地址的访问策略。
ModifyDBProxyEndpointAddress 修改数据库代理的连接地址 该接口用于修改RDS实例数据库代理的连接地址。
ModifyDbProxyInstanceSsl 设置数据库代理连接地址SSL加密 该接口用于设置RDS MySQL数据库代理连接地址的SSL加密。
DescribeDBProxy 查询数据库代理详情 该接口用于查询RDS实例的数据库代理设置详情。
DescribeDBProxyEndpoint 查询数据库代理的连接地址信息 该接口用于查询RDS实例数据库代理的连接地址信息。
DescribeDBProxyPerformance 查询数据库代理的性能数据 该接口用于查询RDS实例数据库代理的性能数据。
GetDbProxyInstanceSsl 查询数据库代理连接地址SSL加密信息 该接口用于查询RDS MySQL数据库代理连接地址SSL加密信息。

数据库共享代理(下线中)

API

标题

API概述

ModifyReadWriteSplittingConnection 修改读写分离链路的延迟阈值和各个实例的读权重 该接口用于修改读写分离链路的延迟阈值和各个实例的读权重。
DescribeDBInstanceProxyConfiguration 查看数据库代理设置 该接口用于查看RDS MySQL数据库代理设置。
AllocateReadWriteSplittingConnection 申请只读地址 该接口用于申请只读地址。
ReleaseReadWriteSplittingConnection 释放读写分离地址 该接口用于释放读写分离地址。
CalculateDBInstanceWeight 查询系统权重分配值 该接口用于查询系统权重分配值。

安全加密

API

标题

API概述

AttachWhitelistTemplateToInstance 关联白名单模板到实例 该接口用于将白名单模板关联到实例。
CreateServiceLinkedRole 创建服务关联角色(SLR) 该接口用于创建服务关联角色(SLR)。
DetachWhitelistTemplateToInstance 取消关联白名单模板与实例 该接口用于取消关联的白名单模板与实例。
ModifyWhitelistTemplate 编辑白名单模板信息 该接口用于编辑白名单模板,包括创建、修改、删除白名单模板的操作。
DescribeSecurityGroupConfiguration 查询RDS实例和ECS安全组关联信息 该接口用于查询指定RDS实例和ECS安全组的关联信息。
ModifySecurityGroupConfiguration 修改RDS实例和ECS安全组关联信息 该接口用于修改指定RDS实例和ECS安全组的关联信息。
CreateDBInstanceSecurityGroupRule 添加安全组规则 该接口用于为RDS SQL Server实例添加安全组规则。
DescribeDBInstanceSecurityGroupRule 查看安全组规则 该接口用于查询RDS SQL Server实例的安全组规则。
ModifyDBInstanceSecurityGroupRule 修改安全组规则 该接口用于修改RDS SQL Server实例的安全组规则。
DeleteDBInstanceSecurityGroupRule 删除安全组规则 该接口用于删除RDS SQL Server实例已设置的安全组规则。
ModifySecurityIps 修改RDS实例IP白名单 修改指定RDS实例的IP白名单配置,支持覆盖、追加、删除三种修改模式。
ModifyDBInstanceSSL 修改RDS实例的SSL配置 该接口用于修改RDS实例的SSL链路配置。
ModifyDBInstanceTDE 修改RDS实例透明数据加密TDE状态 该接口用于开启RDS实例的透明数据加密TDE功能,并支持修改加密状态。
ModifyDTCSecurityIpHostsForSQLServer 设置分布式事务白名单 该接口用于为RDS SQL Server实例设置分布式事务白名单。
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实例的内网IPECS主机名。
DescribeDTCSecurityIpHostsForSQLServer 查询RDS实例的分布式事务白名单信息 该接口用于查询RDS SQL Server实例的分布式事务白名单信息。
MigrateSecurityIPMode 将白名单从通用模式切换为高安全模式 该接口用于将RDS实例的白名单从通用模式切换为高安全模式。

日志

API

标题

API概述

DescribeSQLLogReportList 获取SQL日志报告列表 该接口用于查看SQL日志运行报告列表。
PurgeDBInstanceLog 清理或收缩RDS实例日志 该接口用于清理RDS实例的本地日志。
DescribeSQLLogFiles 查询SQL洞察(SQL审计)导出文件列表 该接口用于查询SQL洞察(SQL审计)导出文件列表。不支持查询通过控制台手动导出的SQL洞察日志文件,只支持查询通过DescribeSQLLogRecords接口生成(请求参数Form取值为File)的SQL洞察文件列表。
DescribeSlowLogs 查看慢日志统计情况 该接口用于查询慢日志统计情况。
DescribeSlowLogRecords 查看慢日志明细 该接口用于查看实例的慢日志明细。
DescribeErrorLogs 查看错误日志 该接口查询实例某段时间内的错误日志。
ModifySQLCollectorPolicy 开启或关闭实例的SQL审计功能(停止维护) 停止维护:可以正常调用,但不再维护。该接口用于开启或关闭实例的SQL洞察(SQL审计)功能。
ModifySQLCollectorRetention 修改RDS实例的SQL洞察日志保存时长(停止维护) 停止维护:可以正常调用,但不再维护。该接口用于修改RDS实例的SQL洞察日志保存时长。
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 查询备份集的库表信息 该接口用于查询目标备份集中可恢复的库表信息。
RecoveryDBInstance 恢复SQL Server数据 该接口用于将RDS SQL Server备份数据恢复到已有实例或新实例上。
CloneDBInstance 恢复数据(克隆实例) 该接口用于将历史数据恢复至一个新实例(称为克隆实例)。
RestoreTable 恢复RDS实例的某些数据库或表到原实例 该接口拥有恢复RDS实例的某些数据库或表到原实例。

跨地域备份恢复

API

标题

API概述

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

监控

API

标题

API概述

ModifyDBInstanceMonitor 设置实例的监控采集粒度 该接口用于修改监控频率。
ModifyDBInstanceMetrics 修改RDS PostgreSQL展示的监控指标项 该接口用于变更RDS PostgreSQL实例展示的增强监控指标。
DescribeResourceUsage 查看实例的空间利用信息 该接口用于查询RDS实例的空间使用信息。
DescribeDBInstancePerformance 查询实例性能数据 该接口用于查询实例性能数据。
DescribeDBInstanceMonitor 查询监控频率 该接口用于查询监控频率。
DescribeAvailableMetrics 查询RDS PostgreSQL的所有监控指标项 该接口用于获取RDS PostgreSQL实例支持的所有增强监控指标。
DescribeDBInstanceMetrics 查询RDS PostgreSQL实例展示的监控指标项 该接口用于查询RDS PostgreSQL实例已开启展示的增强指标。

参数

API

标题

API概述

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

数据迁移

API

标题

API概述

DescibeImportsFromDatabase 查看实例迁移状态列表 该接口用于查看实例迁移状态列表。

运维任务管理

API

标题

API概述

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

PostgreSQL一键上云

API

标题

API概述

CreateCloudMigrationPrecheckTask 创建RDS PostgreSQL一键上云前检查任务 该接口用于创建RDS PostgreSQL一键上云前检查任务。
CreateCloudMigrationTask 创建RDS PostgreSQL迁移上云任务 该接口用于创建RDS PostgreSQL迁移上云任务。
DescribeCloudMigrationPrecheckResult 查询RDS PostgreSQL一键上云前检查报告 该接口用于查询一键上云前检查报告详细信息。
DescribeCloudMigrationResult 查询RDS PostgreSQL迁移上云任务详情 该接口用于查询RDS PostgreSQL迁移上云任务详情。
ActivateMigrationTargetInstance RDS PostgreSQL上云切换 该接口用于执行RDS PostgreSQL上云切换,将RDS PostgreSQL提升为主库,正式提供服务。

标签

API

标题

API概述

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

管理RDS PostgreSQL插件

API

标题

API概述

CreatePostgresExtensions 在目标数据库下安装指定插件 该接口用于在目标数据库下安装指定插件。
DeletePostgresExtensions 删除实例目标数据库下的指定插件 该接口用于删除实例目标数据库下的指定插件。
UpdatePostgresExtensions 升级目标数据库下的指定插件 该接口用于升级目标数据库下的指定插件。
DescribePostgresExtensions 获取实例目标数据库下所有插件的信息 该接口用于获取实例目标数据库下所有插件的信息。

PostgreSQL实例Replication Slot管理

API

标题

API概述

DeleteSlot 删除PostgreSQL实例Replication Slot 该接口用于删除实例的指定Replication Slot。
DescribeSlots 查询PostgreSQL实例Replication Slot 该接口用于查询实例的所有Replication Slot。

承诺型Serverless

API

标题

API概述

ModifyComputeBurstConfig 修改或关闭承诺型Serverless功能 调用该接口,修改或关闭承诺型Serverless功能。
DescribeComputeBurstConfig 查询承诺型Serverless功能配置 查询承诺型Serverless功能的配置。

其他

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备实例。
MigrateConnectionToOtherZone 迁移RDS实例至其他可用区 该接口用于迁移RDS实例的可用区。
ModifyDBInstanceDelayedReplicationTime 修改只读复制延迟阈值 该接口用于设置MySQL只读实例的延迟时间。
CheckServiceLinkedRole 查询是否已创建服务关联角色(SLR) 该接口用于查看是否已创建服务关联角色(SLR)。
DescribeDBMiniEngineVersions 查询可使用的内核版本列表 该接口用于查询可用的MySQLPostgreSQL小版本列表。
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的零停机大版本升级流量切换。
AuthorizeBackupEncryption 校验备份加密 为用户创建备份加密服务关联角色 AliyunServiceRoleForRdsBackupEncryption
CheckBackupEncryptionAuthorized 查询备份加密校验结果 检查用户账号下是否已经创建备份加密服务关联角色 AliyunServiceRoleForRdsBackupEncryption
CheckRegionSupportBackupEncryption 检查单元是否支持备份加密 检查当前region是否支持备份加密
DescribeSQLServerUpgradeVersions 查询SQLServer可升级版本 描述SQLServer实例或指定SQLServer版本允许升级到的版本。
DescribeVpcs 查询专有网络VPC列表 用于查询阿里云账户下的专有网络(VPC)列表信息。
EnableBackupEncryption 开启备份加密 该接口用开启备份加密。
DescribeActiveOperationMaintainConf 查询主动运维配置 获取用户的运维配置信息,目前包括计划内事件周期窗口信息。
CreateMaskingRules 创建加密或脱敏规则 为指定实例创建新的加密或脱敏规则。
ModifyAccountMaskingPrivilege 修改账户脱敏权限 修改指定实例中账号的加密或脱敏权限。
ModifyMaskingRules 修改加密或脱敏规则 用于修改指定实例的加密或脱敏规则。
DescribeMaskingRules 查询加密或脱敏规则 查询指定实例的加密或脱敏规则列表。
DeleteMaskingRules 删除加密或脱敏规则 用于删除指定实例的加密或脱敏规则。
DescribeAccountMaskingPrivilege 查询账号加密或脱敏权限 查询指定实例中账号的加密或脱敏权限配置。
DeleteParameterTimedScheduleTask 删除参数修改定时任务 删除实例参数修改的定时任务。
DescribeParameterTimedScheduleTask 查询实例参数修改定时任务 查询实例参数修改定时任务详情。
ModifyParameterTimedScheduleTask 修改参数定时任务 改变参数修改定时任务中的生效时间
DescribeDBInstanceCLS 查询列加密算法配置 查询指定实例的列加密算法配置信息。
ModifyDBInstanceCLS 修改列加密算法配置 修改指定实例的列加密算法配置。
CreateRCImage Custom实例创建自定义镜像 该接口用于为RDS Custom实例创建自定义镜像。
ModifyDBInstanceVectorSupportStatus 修改实例向量存储开关 打开或者关闭MySQL实例向量存储开关。
DescribeImportTaskValidation 查询导入任务预检查详情 查询导入任务预检查详情,会返回具体的预检查项和检查结果
DescribeImportTask 查询导入任务详情 RDS原生复制实例,查询数据导入任务详情
CreateImportTask 创建数据导入任务 创建数据导入任务
ValidateImportTask 数据导入任务预检查 RDS MySQL原生复制实例数据导入任务预检查
ListImportTasks 列表查询数据导入任务 列表查询原生复制数据导入任务。
ModifyImportTask 修改数据导入任务 修改 RDS MySQL 原生复制实例数据导入任务
ModifyRCDiskAttribute 修改块存储属性 修改一个块存储设备的名称、描述、是否随实例释放、是否随磁盘删除其自动快照、是否启用自动快照策略、是否开启性能突发功能等。
UpdateDBInstanceReplication 更新复制通道 原生复制实例更新复制通道
CreateDBInstanceReplication 创建复制通道 原生复制实例创建复制链路
DeleteDBInstanceReplication 删除复制通道 原生复制实例删除复制链路
ModifyDBInstance 修改实例 修改实例,目前仅支持PostgreSQL引擎。

事件与任务

API

标题

API概述

DescribeHistoryEventsStat 查询统计历史事件 统计事件中心的历史事件。
DescribeHistoryEvents 查询历史事件 查询事件中心的事件列表。
ModifyEventInfo 修改事件信息 修改事件中心的事件信息。
DescribeHistoryTasksStat 统计历史任务 统计任务中心的任务。
DescribeHistoryTasks 查询历史运维任务 该接口用于获取历史任务记录,支持创建时间30天内的任务。
ModifyTaskInfo 修改任务信息 修改任务中心的历史任务信息。

控制台接口

API

标题

API概述

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