本产品（云数据库 RDS/2014-08-15）的OpenAPI采用RPC签名风格，签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（11370001915），在专家指导下进行签名对接。在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见获取AccessKey。
费用
| API | 标题 | API概述 |
|---|---|---|
| DescribePrice | 查询实例的价格 | 该接口用于查询RDS实例的价格信息。 |
| DescribeRenewalPrice | 查询RDS实例续费的费用 | 该接口用于查询包年包月RDS实例续费的费用。 |
| TransformDBInstancePayType | 变更RDS实例的计费方式 | 该接口用于变更RDS实例的计费方式。 |
| RenewInstance | 手动续费RDS实例 | 该接口用于为RDS实例手动续费。 |
| ModifyDBInstancePayType | 按量付费实例转包年包月 | 该接口用于将按量付费实例变更为包年包月实例。 |
| ModifyInstanceAutoRenewalAttribute | 修改RDS实例的自动续费设置 | 该接口用于修改RDS实例的自动续费设置。 |
| DescribeInstanceAutoRenewalAttribute | 查询RDS实例自动续费情况 | 该接口用于查询RDS实例自动续费情况。 |
实例
| API | 标题 | API概述 |
|---|---|---|
| CreateDBInstance | 创建一个RDS实例 | 该接口用于创建RDS实例。 |
| DeleteDBInstance | 释放RDS实例 | 该接口用于释放RDS实例。 |
| CreateDBInstanceForRebuild | 回收站重建实例 | 该接口用于重建已进入回收站的实例。 |
| RestartDBInstance | 重启RDS实例 | 该接口用于手动重启RDS实例。 |
| StopDBInstance | 暂停RDS实例 | 该接口用于暂停RDS实例。 |
| StartDBInstance | 启动RDS实例 | 该接口用于启动暂停的RDS实例。 |
| DescribeSupportOnlineResizeDisk | 查询实例是否支持在线扩盘 | 该接口用于查询RDS SQL Server实例是否支持在线扩盘。 |
| ModifyDBInstanceSpec | 变更RDS实例 | 该接口用于变更RDS实例的规格和存储空间等。 |
| ModifyDasInstanceConfig | 设置存储空间自动扩容 | 该接口用于设置RDS实例的存储空间自动扩容功能。 |
| DescribeAvailableZones | 查询可用区资源 | 该接口用于查询RDS的可用区资源。 |
| DescribeAvailableClasses | 查询实例可变更规格 | 该接口用于查询RDS实例的可变更规格及存储空间等信息。 |
| DescribeDBInstanceAttribute | 查询实例详情 | 该接口用于查询RDS实例的详细信息。 |
| GetDBInstanceTopology | 查询实例拓扑信息 | 该接口用于查看RDS实例的拓扑结构。 |
| DescribeDBInstances | 查询实例列表 | 该接口用于查询RDS的实例列表。 |
| ListClasses | 查询规格信息 | 该接口用于查询RDS实例所有规格的详情。 |
| DescribeDBInstancesByExpireTime | 按过期时间获取数据库实例 | 该接口用于通过包年包月实例的剩余可用时间查询RDS实例信息。 |
| DescribeRegions | 查看可选的地域和可用区 | 该接口用于查询所有RDS地域的详情。 |
| MigrateToOtherZone | 迁移RDS实例可用区 | 该接口用于迁移RDS实例的可用区。 |
| ModifyDBInstanceDescription | 修改实例名称 | 该接口用于修改RDS实例的名称。 |
| ModifyDBInstanceMaintainTime | 修改实例可维护时间段 | 该接口用于修改RDS实例的可维护时间段。 |
| ModifyResourceGroup | 修改实例资源组 | 该接口用于将RDS实例移动到指定资源组。 |
| CheckInstanceExist | 查询实例是否存在 | 该接口用于查询目标RDS实例是否存在。 |
| ModifyHADiagnoseConfig | 修改实例可用性检测方式 | 该接口用于修改RDS实例的可用性检测方式。 |
| DescribeHADiagnoseConfig | 查询实例可用性检测方式 | 该接口用于查询RDS实例的可用性检测方式。 |
| DescribeAnalyticdbByPrimaryDBInstance | 查询RDS MySQL分析实例数量 | 该接口用于查询RDS MySQL实例关联的分析型实例数量。 |
| CheckCloudResourceAuthorized | 查询RDS实例的授权状态 | 该接口用于查询RDS实例的权限状态。 |
| ReleaseInstanceConnection | 释放实例外网连接地址 | 该接口用于释放RDS实例的外网连接地址。 |
升级版本
| API | 标题 | API概述 |
|---|---|---|
| UpgradeDBInstanceEngineVersion | 升级RDS MySQL数据库大版本 | 该接口用于升级RDS MySQL的数据库大版本。 |
| UpgradeDBInstanceKernelVersion | 升级RDS实例内核小版本 | 该接口用于升级RDS实例的内核小版本。 |
| ModifyDBInstanceAutoUpgradeMinorVersion | 修改RDS升级内核小版本的方式 | 该接口用于修改RDS MySQL或RDS PostgreSQL实例升级小版本的方式。 |
| UpgradeDBInstanceMajorVersionPrecheck | RDS PostgreSQL大版本升级前检查 | 该接口用于执行RDS PostgreSQL大版本升级前检查。 |
| DescribeUpgradeMajorVersionPrecheckTask | 查询RDS PostgreSQL大版本升级检查报告 | 该接口用于查询RDS PostgreSQL大版本升级前检查的检查报告。 |
| UpgradeDBInstanceMajorVersion | 升级RDS PostgreSQL数据库大版本 | 该接口用于发起RDS PostgreSQL实例大版本升级任务。 |
| DescribeUpgradeMajorVersionTasks | 查询RDS PostgreSQL实例大版本升级任务 | 该接口用于查询RDS PostgreSQL实例大版本升级的历史任务。 |
网络与连接地址
| API | 标题 | API概述 |
|---|---|---|
| AllocateInstancePublicConnection | 申请外网连接地址 | 该接口用于为RDS实例申请外网连接地址。 |
| DescribeDBInstanceNetInfo | 查询实例的所有连接地址信息 | 该接口用于查询RDS实例的所有连接地址信息。 |
| ModifyDBInstanceConnectionString | 修改实例的连接地址和端口 | 该接口用于修改实例的连接地址和端口。 |
| ModifyDBInstanceNetworkExpireTime | 修改混访模式下经典网络地址过期时间 | 该接口用于修改混访模式下经典网络地址的过期时间。 |
| SwitchDBInstanceNetType | 切换经典网络内外网地址 | 该接口用于切换经典网络实例的内外网地址。 |
| ReleaseInstancePublicConnection | 释放实例的外网连接地址 | 该接口用于释放实例的外网连接地址。 |
| ModifyDBInstanceNetworkType | 经典网络切换为VPC网络 | 该接口用于将经典网络的RDS实例切换为VPC网络。 |
| SwitchDBInstanceVpc | 切换RDS实例的VPC和交换机 | 该接口用于切换RDS实例的专有网络VPC和交换机。 |
| DescribeVSwitches | 查询虚拟交换机列表 | 该接口用于查询专有网络VPC下虚拟交换机的详细信息。 |
| ModifyDBInstanceConfig | 修改RDS实例的配置项 | 该接口用于修改RDS实例的配置项。 |
主备高可用和数据复制方式
| API | 标题 | API概述 |
|---|---|---|
| ModifyDBInstanceHAConfig | 修改实例的高可用模式和数据复制方式 | 该接口用于修改RDS实例的高可用模式和数据复制方式。 |
| DescribeDBInstanceHAConfig | 查询RDS实例高可用模式和数据复制方式 | 该接口用于查询RDS实例的高可用模式和数据复制方式。 |
| SwitchDBInstanceHA | RDS实例主备切换 | 该接口用于RDS实例的手动主备切换。 |
| ModifyHASwitchConfig | 开启或关闭RDS实例的主备自动切换功能 | 该接口用于开启或关闭RDS实例的主备自动切换功能。 |
| DescribeHASwitchConfig | 查询RDS实例主备自动切换设置 | 该接口用于查询RDS实例主备自动切换的设置。 |
历史事件
| API | 标题 | API概述 |
|---|---|---|
| DescribeEvents | 查询历史事件 | 该接口用于查询RDS历史事件记录列表。 |
| DescribeActionEventPolicy | 查询RDS历史事件功能是否开启 | 该接口用于查询RDS的历史事件功能是否开启。 |
| ModifyActionEventPolicy | 开关历史事件 | 该接口用于开启或关闭RDS的历史事件功能。 |
通知
| API | 标题 | API概述 |
|---|---|---|
| QueryNotify | 查询通知 | 该接口用于查询RDS的通知。 |
| ConfirmNotify | 确认通知 | 该接口用于确认主账号下RDS控制台的轮播消息。 |
账号
| API | 标题 | API概述 |
|---|---|---|
| CreateAccount | 创建数据库账号 | 该接口用于创建数据库账号。 |
| DeleteAccount | 删除数据库账号 | 该接口用于删除数据库账号。 |
| ResetAccountPassword | 重置数据库账号的密码 | 该接口用于重置数据库账号的密码。 |
| LockAccount | 锁定RDS PostgreSQL数据库账号 | 该接口用于锁定RDS PostgreSQL实例的数据库账号。 |
| UnlockAccount | 解锁RDS PostgreSQL数据库账号 | 该接口用于解锁RDS PostgreSQL实例的数据库账号。 |
| DescribeAccounts | 查询数据库账号信息 | 该接口用于查询RDS实例的账号信息。 |
| ModifyAccountDescription | 修改数据库账号的备注信息 | 该接口用于修改数据库账号的描述信息。 |
| DescribeInstanceKeywords | 获取实例的保留关键词信息 | 该接口用于查询RDS实例的保留关键字，即创建数据库或账号时禁用的关键字。 |
| ModifyPGHbaConfig | 修改RDS PostgreSQL实例pg_hba.conf文件配置 | 该接口用于修改RDS PostgreSQL实例的pg_hba.conf文件配置。 |
| DescribePGHbaConfig | 查询RDS PostgreSQL实例pg_hba.conf文件配置 | 该接口用于查询RDS PostgreSQL实例的pg_hba.conf文件的配置。 |
| DescribeModifyPGHbaConfigLog | 查询RDS PostgreSQL实例pg_hba.conf文件修改记录 | 该接口用于查询RDS PostgreSQL实例的pg_hba.conf文件的修改记录。 |
| GrantAccountPrivilege | 授权账号访问数据库 | 该接口用于授权数据库账号访问指定的数据库。 |
| GrantOperatorPermission | 授权服务账号 | 该接口用于授权服务账号。 |
| RevokeOperatorPermission | 撤销服务账号权限 | 该接口用于撤销阿里云服务账号对RDS实例的访问权限。 |
| RevokeAccountPrivilege | 撤销账号对数据库的访问权限 | 该接口用于撤销账号对数据库的访问权限。 |
| ResetAccount | 重置高权限账号权限 | 该接口用于重置高权限账号的权限。 |
| CheckAccountNameAvailable | 检查账号名称是否可用 | 该接口用于检查目标需要创建的账号名称是否可用。 |
数据库
| API | 标题 | API概述 |
|---|---|---|
| CreateDatabase | 创建数据库 | 该接口用于在RDS实例下创建数据库。 |
| DeleteDatabase | 删除数据库 | 该接口用于删除RDS实例下的指定数据库。 |
| ModifyDBDescription | 修改数据库备注说明 | 该接口用于修改数据库的备注。 |
| ModifyDatabaseConfig | 修改数据库属性 | 该接口用于修改RDS SQL Server数据库属性。 |
| CopyDatabaseBetweenInstances | RDS SQL Server实例间复制数据库 | 该接口用于在RDS SQL Server实例间复制数据库。 |
| DescribeDatabases | 查看实例下的数据库信息 | 该接口用于查询RDS实例下的数据库信息。 |
| CheckDBNameAvailable | 检查数据库名称是否可用 | 该接口用于检查数据库名称是否重复或不符合命名规范。 |
| DescribeCollationTimeZones | 查询RDS SQL Server支持的字符集排序规则和时区 | 该接口用于查询RDS SQL Server支持的字符集排序规则和时区。 |
| DescribeCharacterSetName | 查看数据库支持的字符集列表 | 该接口用于查询RDS实例支持的字符集。 |
只读实例
| API | 标题 | API概述 |
|---|---|---|
| CreateReadOnlyDBInstance | 创建只读实例 | 该接口用于为RDS实例创建一个只读实例。 |
| DescribeReadDBInstanceDelay | 查询RDS只读实例的延迟信息 | 该接口用于查询RDS只读实例的延迟信息。 |
| ModifyReadonlyInstanceDelayReplicationTime | 修改RDS MySQL只读实例的延迟复制时间 | 该接口用于修改RDS MySQL只读实例的延迟复制时间。 |
RDS MySQL集群系列实例
| API | 标题 | API概述 |
|---|---|---|
| CreateDBNodes | 创建节点 | 该接口用于为RDS MySQL集群系列实例新增节点。 |
| DeleteDBNodes | 删除节点 | 该接口用于为RDS MySQL集群系列实例删除节点。 |
| ModifyDBNode | 变更RDS实例节点 | 该接口用于变更RDS MySQL集群系列实例节点的规格、存储类型、存储空间。 |
| DescribeDBInstanceEndpoints | 查询实例Endpoint信息 | 该接口用于查询RDS MySQL集群系列实例的Endpoint信息。 |
| CreateDBInstanceEndpoint | 创建实例的Endpoint | 该接口用于为RDS MySQL集群系列实例创建Endpoint。 |
| DeleteDBInstanceEndpoint | 删除实例的Endpoint | 该接口用于删除RDS MySQL集群系列实例的Endpoint。 |
| ModifyDBInstanceEndpoint | 修改实例的Endpoint权重信息 | 该接口用于修改RDS MySQL集群系列实例的Endpoint权重信息。 |
| CreateDBInstanceEndpointAddress | 创建Endpoint外网连接地址 | 该接口用于为RDS MySQL集群系列实例创建Endpoint的外网连接地址。 |
| DeleteDBInstanceEndpointAddress | 释放Endpoint外网连接地址 | 该接口用于释放RDS MySQL集群系列实例的Endpoint的外网连接地址。 |
| ModifyDBInstanceEndpointAddress | 修改实例的Endpoint连接地址信息 | 该接口用于修改RDS MySQL集群系列实例的Endpoint连接地址信息。 |
数据库共享代理（下线中）
| API | 标题 | API概述 |
|---|---|---|
| AllocateReadWriteSplittingConnection | 申请只读地址 | 该接口用于申请只读地址。 |
| ReleaseReadWriteSplittingConnection | 释放读写分离地址 | 该接口用于释放读写分离地址。 |
| CalculateDBInstanceWeight | 查询系统权重分配值 | 该接口用于查询系统权重分配值。 |
| ModifyReadWriteSplittingConnection | 修改读写分离链路的延迟阈值和各个实例的读权重 | 该接口用于修改读写分离链路的延迟阈值和各个实例的读权重。 |
| DescribeDBInstanceProxyConfiguration | 查看数据库代理设置 | 该接口用于查看数据库代理设置。 |
数据库独享代理（读写分离）
| API | 标题 | API概述 |
|---|---|---|
| ModifyDBProxy | 开启或关闭实例数据库独享代理功能 | 该接口用于开启或者关闭RDS实例的数据库独享代理功能。 |
| UpgradeDBProxyInstanceKernelVersion | 升级独享代理内核小版本 | 该接口用于升级独享代理的内核小版本。 |
| ModifyDBProxyInstance | 修改RDS数据库独享代理的代理数量 | 该接口用于修改RDS数据库独享代理的代理数量。 |
| ModifyDBProxyEndpoint | 修改数据库独享代理的代理终端 | 该接口用于修改RDS实例数据库独享代理的代理终端配置。 |
| DescribeDBProxy | 查询RDS实例的数据库独享代理详情 | 该接口用于查询RDS实例的数据库独享代理设置详情。 |
| DescribeDBProxyEndpoint | 查询RDS实例独享代理的连接地址信息 | 该接口用于查询RDS实例独享代理的连接地址信息。 |
| DescribeDBProxyPerformance | 查询独享代理的性能数据 | 该接口用于查询RDS实例独享代理的性能数据。 |
| CreateDBProxyEndpointAddress | 创建RDS实例独享代理的连接地址 | 该接口用于创建RDS实例独享代理的连接地址。 |
| ModifyDBProxyEndpointAddress | 修改RDS实例独享代理的连接地址 | 该接口用于修改RDS实例独享代理的连接地址。 |
| DeleteDBProxyEndpointAddress | 删除独享代理连接地址 | 该接口用于删除RDS实例独享代理的连接地址。 |
| ModifyDbProxyInstanceSsl | 设置独享代理连接地址SSL加密 | 该接口用于设置RDS MySQL独享代理连接地址的SSL加密。 |
| GetDbProxyInstanceSsl | 查询独享代理连接地址SSL加密信息 | 该接口用于查询RDS MySQL独享代理连接地址SSL加密信息。 |
安全加密
| API | 标题 | API概述 |
|---|---|---|
| DescribeWhitelistTemplateLinkedInstance | 查询白名单模板关联实例 | 该接口用于根据白名单模板查询关联的实例。 |
| DescribeInstanceLinkedWhitelistTemplate | 查询实例关联的白名单模板 | 该接口用于根据实例的名称查询关联的白名单模板。 |
| DescribeWhitelistTemplate | 查询白名单模板信息 | 该接口用于获取指定的白名单模板信息。 |
| DescribeAllWhitelistTemplate | 批量查询白名单模板信息 | 该接口用于批量获取白名单模板，支持模糊查询。 |
| DetachWhitelistTemplateToInstance | 取消关联白名单模板与实例 | 该接口用于取消关联的白名单模板与实例。 |
| ModifyWhitelistTemplate | 编辑白名单模板信息 | 该接口用于编辑白名单模板，包括创建、修改、删除白名单模板的操作。 |
| AttachWhitelistTemplateToInstance | 关联白名单模板到实例 | 该接口用于将白名单模板关联到实例。 |
| DescribeSecurityGroupConfiguration | 查询RDS实例和ECS安全组关联信息 | 该接口用于查询指定RDS实例和ECS安全组的关联信息。 |
| ModifySecurityGroupConfiguration | 修改RDS实例和ECS安全组关联信息 | 该接口用于修改指定RDS实例和ECS安全组的关联信息。 |
| DescribeDBInstanceIPArrayList | 查看RDS实例IP白名单 | 该接口用于查询RDS实例的IP白名单。 |
| ModifySecurityIps | 修改RDS实例IP白名单 | 该接口用于修改RDS实例的IP白名单。 |
| DescribeDBInstanceSSL | 查询RDS实例的SSL配置 | 该接口用于查询RDS实例的SSL配置情况。 |
| ModifyDBInstanceSSL | 修改RDS实例的SSL配置 | 该接口用于修改RDS实例的SSL链路配置。 |
| DescribeDBInstanceTDE | 查询RDS实例透明数据加密TDE状态 | 该接口用于查询RDS实例的透明数据加密TDE的加密状态。 |
| ModifyDBInstanceTDE | 修改RDS实例透明数据加密TDE状态 | 该接口用于开启RDS实例的透明数据加密TDE功能，并支持修改加密状态。 |
| MigrateSecurityIPMode | 将白名单从通用模式切换为高安全模式 | 该接口用于将RDS实例的白名单从通用模式切换为高安全模式。 |
| DescribeDBInstanceIpHostname | 查询实例底层ECS实例的Hostname | 该接口用于查询RDS SQL Server实例底层ECS实例的Hostname。 |
| ModifyDTCSecurityIpHostsForSQLServer | 设置分布式事务白名单 | 该接口用于为RDS SQL Server实例设置分布式事务白名单。 |
| DescribeDTCSecurityIpHostsForSQLServer | 查询RDS实例的分布式事务白名单信息 | 该接口用于查询RDS SQL Server实例的分布式事务白名单信息。 |
| CreateServiceLinkedRole | 创建服务关联角色（SLR） | 该接口用于创建服务关联角色（SLR）。 |
| ModifyDBInstanceDeletionProtection | 开启或关闭实例释放保护 | 该接口用于开启或关闭RDS实例的释放保护功能。 |
日志
| API | 标题 | API概述 |
|---|---|---|
| ModifySQLCollectorPolicy | 开启或关闭实例的SQL审计功能 | 该接口用于开启或关闭实例的SQL洞察（SQL审计）功能。 |
| DescribeSQLCollectorPolicy | 查询实例的SQL审计功能是否开启 | 该接口用于查询RDS实例的SQL洞察（SQL审计）功能是否开启。 |
| DescribeSQLLogRecords | 查询实例的SQL审计日志 | 该接口用于查询RDS实例的SQL洞察（SQL审计）日志。 |
| DescribeSQLLogFiles | 查询SQL洞察（SQL审计）导出文件列表 | 该接口用于查询SQL洞察（SQL审计）导出文件列表。不支持查询通过控制台手动导出的SQL洞察日志文件，只支持查询通过DescribeSQLLogRecords接口生成（请求参数Form取值为File）的SQL洞察文件列表。 |
| ModifySQLCollectorRetention | 修改RDS实例的SQL洞察日志保存时长 | 该接口用于修改RDS实例的SQL洞察日志保存时长。 |
| DescribeSQLCollectorRetention | 查询RDS实例的SQL洞察日志保存时长 | 该接口用于查询RDS实例的SQL洞察日志保存时长。 |
| DescribeSlowLogs | 查看慢日志统计情况 | 该接口用于查询慢日志统计情况。 |
| DescribeSlowLogRecords | 查看慢日志明细 | 该接口用于查看实例的慢日志明细。 |
| DescribeErrorLogs | 查看错误日志 | 该接口查询实例某段时间内的错误日志。 |
| PurgeDBInstanceLog | 清理或收缩RDS实例日志 | 该接口用于清理RDS实例的本地日志。 |
| DescribeSQLLogReportList | 获取SQL日志报告列表 | 该接口用于查看SQL日志运行报告列表。 |
备份
| API | 标题 | API概述 |
|---|---|---|
| CreateBackup | 为RDS实例创建备份集 | 该接口用于为RDS实例创建一个备份集。 |
| DescribeBackups | 查看RDS实例备份集列表 | 该接口用于查看RDS实例的备份集列表。 |
| DescribeDetachedBackups | 查询已被释放的RDS实例中备份集列表 | 该接口用于查看已被释放的RDS实例的备份集列表。 |
| DescribeBackupPolicy | 查看实例备份设置 | 该接口用于查询RDS实例的备份设置。 |
| ModifyBackupPolicy | 修改实例备份策略 | 该接口用于修改RDS实例的备份策略设置。 |
| DeleteBackup | 删除实例数据备份文件 | 该接口用于删除RDS实例的数据备份文件。 |
| DescribeBackupTasks | 查询实例的备份任务列表 | 该接口用于查询RDS实例的备份任务列表。 |
| DescribeBinlogFiles | 查看RDS实例的日志（Binglog/Wal）文件 | 该接口用于查询RDS MySQL/RDS MariaDB实例的Binlog日志或RDS PostgreSQL实例的Wal日志。 |
| DeleteBackupFile | 删除SQL Server备份文件 | 该接口用于删除RDS SQL Server的备份文件。 |
| DescribeLogBackupFiles | 查询实例的日志备份文件 | 该接口用于查询RDS SQL Server实例的日志备份文件。 |
恢复
| API | 标题 | API概述 |
|---|---|---|
| RecoveryDBInstance | 恢复数据库 | 该接口用于恢复RDS SQL Server数据库。 |
| CloneDBInstance | 恢复数据（克隆实例） | 该接口用于将历史数据恢复至一个新实例（称为克隆实例）。 |
| CreateTempDBInstance | 创建临时实例 | 该接口用于为RDS SQL Server 2008 R2本地盘实例创建临时实例。 |
| DescribeLocalAvailableRecoveryTime | 查询RDS实例备份可恢复的时间范围 | 该接口用于查询RDS实例备份可恢复的时间范围。 |
| RestoreTable | 恢复RDS实例的某些数据库或表到原实例 | 该接口拥有恢复RDS实例的某些数据库或表到原实例。 |
| DescribeMetaList | 查询备份集的库表信息 | 该接口用于查询目标备份集中可恢复的库表信息。 |
跨地域备份恢复
| API | 标题 | API概述 |
|---|---|---|
| CheckCreateDdrDBInstance | 预检查实例是否可以进行跨地域恢复 | 该接口用于预检查某RDS实例是否可以用跨地域备份集进行跨地域恢复。 |
| CreateDdrInstance | 跨地域恢复数据到新实例 | 该接口用于跨地域恢复数据到新实例。 |
| RestoreDdrTable | 跨地域恢复数据到已有实例 | 该接口用于跨地域恢复数据到已有实例。 |
| ModifyInstanceCrossBackupPolicy | 修改RDS跨地域备份设置 | 该接口用于修改RDS跨地域备份设置。 |
| DescribeInstanceCrossBackupPolicy | 查询跨地域备份设置 | 该接口用于查询跨地域备份设置。 |
| DescribeCrossBackupMetaList | 查询实例跨地域备份的库表信息 | 该接口用于查询RDS实例跨地域备份的库表信息。 |
| DescribeCrossRegionBackups | 查询某RDS实例跨地域数据备份文件列表 | 该接口用于查询某RDS实例跨地域数据备份文件列表。 |
| DescribeCrossRegionLogBackupFiles | 查询跨地域日志备份文件列表 | 该接口用于查询跨地域日志备份文件列表。 |
| DescribeAvailableCrossRegion | 查询可以进行跨地域备份的目的地域 | 该接口用于查询所选地域当前可以进行跨地域备份的目的地域。 |
| DescribeAvailableRecoveryTime | 查询备份文件可恢复的时间段 | 该接口用于查询某跨地域备份文件可恢复哪个时间段的数据。 |
| DescribeCrossRegionBackupDBInstance | 查询开启跨地域备份实例 | 该接口用于查询所选地域的哪些实例开启了跨地域备份，以及这些实例的跨地域备份设置。 |
监控
| API | 标题 | API概述 |
|---|---|---|
| DescribeResourceUsage | 查看实例的空间利用信息 | 该接口用于查询RDS实例的空间使用信息。 |
| DescribeDBInstancePerformance | 查询实例性能数据 | 该接口用于查询实例性能数据。 |
| DescribeDBInstanceMonitor | 查询监控频率 | 该接口用于查询监控频率。 |
| ModifyDBInstanceMonitor | 设置实例的监控采集粒度 | 该接口用于修改监控频率。 |
| DescribeAvailableMetrics | 查询RDS PostgreSQL的所有监控指标项 | 该接口用于获取RDS PostgreSQL实例支持的所有增强监控指标。 |
| ModifyDBInstanceMetrics | 修改RDS PostgreSQL展示的监控指标项 | 该接口用于变更RDS PostgreSQL实例展示的增强监控指标。 |
| DescribeDBInstanceMetrics | 查询RDS PostgreSQL实例展示的监控指标项 | 该接口用于查询RDS PostgreSQL实例已开启展示的增强指标。 |
参数
| API | 标题 | API概述 |
|---|---|---|
| DescribeParameters | 查询实例当前的参数配置 | 该接口用于查询实例当前的参数配置。 |
| ModifyParameter | 修改实例参数 | 该接口用于修改RDS实例的参数值。 |
| DescribeModifyParameterLog | 查询RDS实例的参数修改日志 | 该接口用于查询RDS实例的参数修改日志。 |
| DescribeParameterTemplates | 查看参数模板详情列表 | 该接口用于查询数据库参数模板。 |
| CreateParameterGroup | 创建参数模板 | 该接口用于创建RDS参数模板。 |
| ModifyParameterGroup | 修改参数模板 | 该接口用于修改RDS参数模板。 |
| CloneParameterGroup | 复制参数模板 | 该接口用于复制RDS参数模板到当前地域或其他地域内。 |
| DescribeParameterGroups | 查询目标地域的参数模板列表 | 该接口用于查询目标地域的参数模板列表。 |
| DescribeParameterGroup | 查询指定的RDS参数模板信息 | 该接口用于查询指定的RDS参数模板信息。 |
| DeleteParameterGroup | 删除参数模板 | 该接口用于删除RDS参数模板。 |
数据迁移
| API | 标题 | API概述 |
|---|---|---|
| ImportDatabaseBetweenInstances | 从其他RDS SQL Server实例迁入数据 | 该接口用于从其它RDS SQL Server实例迁入数据。 |
| CancelImport | 取消RDS SQL Server实例迁移任务 | 该接口用于取消RDS SQL Server实例的迁移任务。 |
| DescibeImportsFromDatabase | 查看实例迁移状态列表 | 该接口用于查看实例迁移状态列表。 |
运维任务管理
| API | 标题 | API概述 |
|---|---|---|
| ModifyActiveOperationTasks | 修改多个主动运维任务切换时间 | 该接口用于修改RDS实例计划内运维任务的切换时间。 |
| DescribeActiveOperationTasks | 查询多个主动运维任务信息 | 该接口用于查看RDS实例的计划内运维任务详情。 |
MySQL备份文件上云
| API | 标题 | API概述 |
|---|---|---|
| ImportUserBackupFile | 导入用户备份 | 该接口用于将自建库MySQL 5.7的备份数据导入至RDS。 |
| UpdateUserBackupFile | 变更用户备份信息 | 该接口用于变更用户备份的备注信息和保留时长。 |
| ListUserBackupFiles | 查询用户备份信息 | 该接口用于查询所有已导入至RDS的用户备份的详情。 |
| DeleteUserBackupFile | 删除用户备份 | 该接口用于删除RDS MySQL的目标用户备份。 |
SQL Server备份文件上云
| API | 标题 | API概述 |
|---|---|---|
| CreateMigrateTask | 创建上云迁移任务 | 该接口用于将OSS上的备份文件还原到RDS SQL Server实例，实现数据上云。 |
| DescribeMigrateTasks | 查询备份数据上云任务列表 | 该接口用于查询RDS SQL Server实例备份数据上云任务列表。 |
| DescribeOssDownloads | 查看备份数据上云任务的文件详情 | 该接口用于查询RDS SQL Server备份数据上云任务的文件详情。 |
| CreateOnlineDatabaseTask | 打开备份数据上云任务的数据库 | 该接口用于打开RDS SQL Server备份数据上云任务的数据库。 |
| DescribeMigrateTaskById | 获取迁移任务 | 该接口用于查询SQL Server的某个OSS备份上云任务的信息。 |
| TerminateMigrateTask | 终止迁移任务 | 该接口用于终止进行中的RDS SQL Server的备份上云任务。 |
SQL Server AD域
| API | 标题 | API概述 |
|---|---|---|
| ModifyADInfo | 修改RDS SQL Server的AD域配置 | 该接口用于修改RDS SQL Server实例的AD域信息。 |
| DeleteADSetting | 删除RDS SQL Server的AD域关联 | 该接口用于将当前RDS SQL Server实例退出所在域。 |
| DescribeADInfo | 查询RDS SQL Server的AD域关联信息 | 该接口用于查询当前实例域相关信息, 包括是否已经加入域、域名称、所使用账号等。 |
PostgreSQL一键上云
| API | 标题 | API概述 |
|---|---|---|
| CreateCloudMigrationPrecheckTask | 创建RDS PostgreSQL一键上云前检查任务 | 该接口用于创建RDS PostgreSQL一键上云前检查任务。 |
| DescribeCloudMigrationPrecheckResult | 查询RDS PostgreSQL一键上云前检查报告 | 该接口用于查询一键上云前检查报告详细信息。 |
| CreateCloudMigrationTask | 创建RDS PostgreSQL迁移上云任务 | 该接口用于创建RDS PostgreSQL迁移上云任务。 |
| ActivateMigrationTargetInstance | RDS PostgreSQL上云切换 | 该接口用于执行RDS PostgreSQL上云切换，将RDS PostgreSQL提升为主库，正式提供服务。 |
| DescribeCloudMigrationResult | 查询RDS PostgreSQL迁移上云任务详情 | 该接口用于查询RDS PostgreSQL迁移上云任务详情。 |
全球多活数据库集群
| API | 标题 | API概述 |
|---|---|---|
| DescribeGadInstances | 查询Gad实例列表 | 该接口用于查询RDS MySQL全球多活数据库集群列表或目标集群的详细信息。 |
| CreateGADInstance | 创建GAD实例 | 该接口用于创建RDS全球多活数据库集群。 |
| CreateGadInstanceMember | 创建Gad实例成员 | 该接口用于在RDS全球多活数据库集群中添加节点。 |
| DeleteGadInstance | 删除Gad实例 | 该接口用于删除RDS全球多活数据库集群。 |
| DetachGadInstanceMember | 分离Gad实例成员 | 该接口用于移除RDS全球多活数据库集群中的单元节点。 |
标签
| API | 标题 | API概述 |
|---|---|---|
| ListTagResources | 查询标签和资源列表 | 该接口用于查询一个或多个RDS实例已经绑定的标签列表。 |
| DescribeTags | 查询标签列表 | 该接口用于查询RDS实例的标签信息。 |
| TagResources | 创建标签 | 该接口用于为指定的RDS实例创建并绑定标签。 |
| UntagResources | 解绑标签 | 该接口用于为指定的RDS实例解绑标签。 |
| AddTagsToResource | 为实例绑定标签 | 该接口用于为实例绑定标签。 |
| RemoveTagsFromResource | 为RDS实例解绑标签 | 该接口用于解绑标签。 |
| DescribeDBInstanceByTags | 查询实例标签信息 | 该接口用于获取实例绑定的标签信息。 |
管理RDS PostgreSQL插件
| API | 标题 | API概述 |
|---|---|---|
| CreatePostgresExtensions | 在目标数据库下安装指定插件 | 该接口用于在目标数据库下安装指定插件。 |
| UpdatePostgresExtensions | 升级目标数据库下的指定插件 | 该接口用于升级目标数据库下的指定插件。 |
| DescribePostgresExtensions | 获取实例目标数据库下所有插件的信息 | 该接口用于获取实例目标数据库下所有插件的信息。 |
| DeletePostgresExtensions | 删除实例目标数据库下的指定插件 | 该接口用于删除实例目标数据库下的指定插件。 |
PostgreSQL实例Replication Solt管理
| API | 标题 | API概述 |
|---|---|---|
| DescribeSlots | 查询PostgreSQL实例Replication Slot | 该接口用于查询实例的所有Replication Slot。 |
| DeleteSlot | 删除PostgreSQL实例Replication Slot | 该接口用于删除实例的指定Replication Slot。 |
其他
| API | 标题 | API概述 |
|---|---|---|
| 用户凭证 | 用户凭证 | |
| CreateSecret | 创建用户凭证 | 该接口用于创建Data API用户凭证。 |
| DescribeSecrets | 查询用户凭证 | 该接口用于查询Data API用户凭证。 |
| DeleteSecret | 删除用户凭证 | 调用DeleteSecret接口删除Data API用户凭证。 |
| 主机 | 主机 | |
| DescribeDedicatedHostGroups | 查询RDS主机组信息 | 查询RDS专属集群信息。 |
| MigrateDBInstance | 迁移主机组内的RDS实例 | 调用MigrateDBInstance接口迁移专属集群内的RDS实例。 |
| DescribeDedicatedHosts | 查询RDS主机组内的主机信息 | 查询专属集群内的主机信息。 |
| RebuildDBInstance | 将RDS主机组内实例的备实例重建 | 调用RebuildDBInstance接口重建专属集群中的RDS备实例。 |
| CheckServiceLinkedRole | 查询是否已创建服务关联角色（SLR） | 该接口用于查看是否已创建服务关联角色（SLR）。 |
| DescribeDBMiniEngineVersions | 查询可使用的内核版本列表 | 该接口用于查询可用的MySQL或PostgreSQL小版本列表。 |
| MigrateConnectionToOtherZone | 迁移RDS实例至其他可用区 | 该接口用于迁移RDS实例的可用区。 |
| DescribeDBInstanceEncryptionKey | 查询云盘加密状态及密钥详情 | 查询RDS实例是否开启了云盘加密，以及密钥详情。 |
| DescribeRegionInfos | 查询可见地域列表 | 该接口用于获取地域列表。 |
| DescribeDBInstanceNetInfoForChannel | 查询实例网络信息 | 该接口用于查询RDS实例的所有连接地址信息。 |
| ModifyDBInstanceDelayedReplicationTime | 修改只读复制延迟阈值 | 该接口用于设置MySQL只读实例的延迟时间。 |
| DescribeHistoryTasks | 查询历史运维任务 | 该接口用于获取历史任务记录，支持创建时间30天内的任务。 |
| DescribeHostWebShell | 查询RDS SQL Server实例的主机WebShell登录信息 | 该接口用于查询RDS SQL Server实例的主机WebShell登录信息。 |
| DescribeClassDetails | 查询规格详情 | 该接口用于通过规格代码查询规格详情。 |
控制台接口
| API | 标题 | API概述 |
|---|---|---|
| CreateYouhuiForOrder | 领取优惠券 | |
| DescribeCurrentModifyOrder | 查询实例最新变配订单 | |
| DescribeCustinsResourceInfo | 查询实例资源使用情况 | |
| DescribeDBInstanceConnectivity | 查询数据库实例连接 | |
| DescribeHostGroupElasticStrategyParameters | 查询主机组弹性策略配置 | |
| DescribeMarketingActivity | 查询营销活动 | |
| DescribeQuickSaleConfig | 查询快捷售卖商品配置 | |
| DescribeResourceDetails | 查询资源详细信息 | |
| EvaluateLocalExtendDisk | 评估本地扩展磁盘 | |
| ModifyCustinsResource | 修改实例资源 | |
| PreCheckCreateOrderForCreateDBNodes | 创建实例节点预检查 | |
| PreCheckCreateOrderForDeleteDBNodes | 删除实例节点预检查 | |
| QueryRecommendByCode | Rds热点问题查询 | |
| CreateOrderForCreateDBNodes | 创建实例节点 | 该接口用于为RDS MySQL集群系列实例新增节点。 |
| CreateOrderForDeleteDBNodes | 删除实例节点 | 该接口用于为RDS MySQL集群系列实例删除节点。 |
停止维护的接口
| API | 标题 | API概述 |
|---|---|---|
| 数据库性能优化 | 数据库性能优化 | |
| CreateDiagnosticReport | 创建诊断报告 | 该接口用于创建诊断报告。 |
| DescribeDiagnosticReportList | 查询诊断报告列表 | 该接口用于查询诊断报告列表。 |
| SwitchGuardToMasterInstance | 将灾备实例切换为独立的主实例 | 该接口用于将灾备实例切换成主实例。 |
| ReceiveDBInstance | 将RDS主实例切换为灾备实例 | 该接口用于将主实例切换成灾备实例，将灾备实例切换成主实例。 |
| DescribeDBInstancePromoteActivity | 查询实例命中的促销活动 | 该接口已下线，暂无法使用。 |
| DescribeBackupDatabase | 查询备份集数据库列表 | 查询备份集下的数据库列表，已下线。 |
| DescribeTasks | 查询迁移结果 | 调用DescribeTasks接口查询RDS实例正在进行中的任务。 |
| DescribeDBInstancesForClone | 获取克隆数据库实例 | 调用DescribeDBInstancesForClone查看实例列表。 |
| CopyDatabase | 复制数据库 | 复制数据库SQL Server 2008 R2版，已下线。 |
| DescribeDBInstancesByPerformance | 按性能获取数据库实例 | 调用DescribeDBInstancesByPerformance接口查询实例性能。 |
| DescribeDBInstanceDetail | 获取数据库实例详细信息 | 调用DescribeDBInstanceDetail接口查询实例详情。 |
| ModifyDBInstanceProxyConfiguration | 设置数据库代理 | 调用ModifyDBInstanceProxyConfiguration接口设置数据库代理，已下线。 |
| ModifyCollationTimeZone | 修改系统库字符集排序规则和时区 | 修改系统库的字符集排序规则和时区，已下线。 |
| ModifyDBInstanceConnectionMode | 开启或关闭数据库代理 | 开启或关闭数据库代理，已下线。 |
| DescribeRdsResourceSettings | 获取RDS资源设置 | 此API已废弃，不再使用。 |
| DestroyDBInstance | 销毁实例 | 该接口用于销毁回收站中的RDS实例。 |
| DescribeDBInstancesAsCsv | 按CSV文件格式查询实例列表 | 该接口用于查询实例列表。 |
内容没看懂？ 不太想学习？想快速解决？ 有偿解决： 联系专家
阿里云企业补贴进行中： 马上申请
腾讯云限时活动1折起，即将结束： 马上收藏
同尘科技为腾讯云授权服务中心。
购买腾讯云产品享受折上折，更有现金返利:同意关联，立享优惠
转转请注明出处：https://www.yunxiaoer.com/154020.html
