备案控制台
文档
产品文档
输入文档关键字查找
首页 云数据库 RDS RDS PostgreSQL数据库 开发参考 RDS PostgreSQL API参考 API概览

API概览

更新时间：
一键部署
产品详情
相关技术圈
我的收藏
本产品（云数据库 RDS/2014-08-15）的OpenAPI采用RPC签名风格，签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（11370001915），在专家指导下进行签名对接。
在使用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实例。
StopDBInstance暂停RDS实例该接口用于暂停RDS实例。
StartDBInstance启动RDS实例该接口用于启动暂停的RDS实例。
ModifyDBInstanceSpec变更RDS实例该接口用于变更RDS实例的规格和存储空间等。
ModifyDasInstanceConfig设置存储空间自动扩容该接口用于设置RDS实例的存储空间自动扩容功能。
MigrateToOtherZone迁移RDS实例可用区该接口用于迁移RDS实例的可用区。
ModifyDBInstanceDescription修改实例名称该接口用于修改RDS实例的名称。
ModifyDBInstanceMaintainTime修改实例可维护时间段该接口用于修改RDS实例的可维护时间段。
ModifyResourceGroup修改实例资源组该接口用于将RDS实例移动到指定资源组。
ModifyHADiagnoseConfig修改实例可用性检测方式该接口用于修改RDS实例的可用性检测方式。
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实例的外网连接地址。

升级版本

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

网络与连接地址

API标题API概述
AllocateInstancePublicConnection申请外网连接地址该接口用于为RDS实例申请外网连接地址。
ReleaseInstancePublicConnection释放实例的外网连接地址该接口用于释放实例的外网连接地址。
ModifyDBInstanceConnectionString修改实例的连接地址和端口该接口用于修改实例的连接地址和端口。
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实例主备自动切换的设置。
SwitchDBInstanceHARDS实例主备切换该接口用于RDS实例的手动主备切换。

历史事件

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

通知

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

账号

API标题API概述
CreateAccount创建数据库账号该接口用于创建数据库账号。
DeleteAccount删除数据库账号该接口用于删除数据库账号。
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授权账号访问数据库该接口用于授权数据库账号访问指定的数据库。
CheckAccountNameAvailable检查账号名称是否可用该接口用于检查目标需要创建的账号名称是否可用。

数据库

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

只读实例

API标题API概述
CreateReadOnlyDBInstance创建只读实例该接口用于为RDS实例创建一个只读实例。
DescribeReadDBInstanceDelay查询RDS只读实例的延迟信息该接口用于查询RDS只读实例的延迟信息。

RDS集群系列实例

API标题API概述
CreateDBNodes创建节点该接口用于为RDS MySQL或RDS PostgreSQL集群系列实例新增节点。
CreateDBInstanceEndpoint创建实例的Endpoint该接口用于为RDS MySQL或RDS PostgreSQL集群系列实例创建Endpoint。
ModifyDBInstanceEndpointAddress修改实例的Endpoint连接地址信息该接口用于修改RDS MySQL或RDS PostgreSQL集群系列实例的Endpoint连接地址信息。

数据库代理

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

安全加密

API标题API概述
AttachWhitelistTemplateToInstance关联白名单模板到实例该接口用于将白名单模板关联到实例。
CreateServiceLinkedRole创建服务关联角色（SLR）该接口用于创建服务关联角色（SLR）。
DetachWhitelistTemplateToInstance取消关联白名单模板与实例该接口用于取消关联的白名单模板与实例。
ModifyWhitelistTemplate编辑白名单模板信息该接口用于编辑白名单模板，包括创建、修改、删除白名单模板的操作。
ModifySecurityGroupConfiguration修改RDS实例和ECS安全组关联信息该接口用于修改指定RDS实例和ECS安全组的关联信息。
ModifySecurityIps修改RDS实例IP白名单该接口用于修改RDS实例的IP白名单。
ModifyDBInstanceSSL修改RDS实例的SSL配置该接口用于修改RDS实例的SSL链路配置。
ModifyDBInstanceTDE修改RDS实例透明数据加密TDE状态该接口用于开启RDS实例的透明数据加密TDE功能，并支持修改加密状态。
ModifyDBInstanceDeletionProtection开启或关闭实例释放保护该接口用于开启或关闭RDS实例的释放保护功能。
DescribeWhitelistTemplateLinkedInstance查询白名单模板关联实例该接口用于根据白名单模板查询关联的实例。
DescribeInstanceLinkedWhitelistTemplate查询实例关联的白名单模板该接口用于根据实例的名称查询关联的白名单模板。
DescribeWhitelistTemplate查询白名单模板信息该接口用于获取指定的白名单模板信息。
DescribeAllWhitelistTemplate批量查询白名单模板信息该接口用于批量获取白名单模板，支持模糊查询。
DescribeSecurityGroupConfiguration查询RDS实例和ECS安全组关联信息该接口用于查询指定RDS实例和ECS安全组的关联信息。
DescribeDBInstanceIPArrayList查看RDS实例IP白名单该接口用于查询RDS实例的IP白名单。
DescribeDBInstanceSSL查询RDS实例的SSL配置该接口用于查询RDS实例的SSL配置情况。
DescribeDBInstanceTDE查询RDS实例透明数据加密TDE状态该接口用于查询RDS实例的透明数据加密TDE的加密状态。
MigrateSecurityIPMode将白名单从通用模式切换为高安全模式该接口用于将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洞察文件列表。
DescribeSQLCollectorRetention查询RDS实例的SQL洞察日志保存时长该接口用于查询RDS实例的SQL洞察日志保存时长。
DescribeSlowLogRecords查看慢日志明细该接口用于查看实例的慢日志明细。
DescribeErrorLogs查看错误日志该接口查询实例某段时间内的错误日志。
DescribeSQLLogReportList获取SQL日志报告列表该接口用于查看SQL日志运行报告列表。

备份

API标题API概述
CreateBackup为RDS实例创建备份集该接口用于为RDS实例创建一个备份集。
DeleteBackup删除实例数据备份文件该接口用于删除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概述
CreateDdrInstance跨地域恢复数据到新实例该接口用于跨地域恢复数据到新实例。
ModifyInstanceCrossBackupPolicy修改RDS跨地域备份设置该接口用于修改RDS跨地域备份设置。
DescribeInstanceCrossBackupPolicy查询跨地域备份设置该接口用于查询跨地域备份设置。
DescribeCrossBackupMetaList查询实例跨地域备份的库表信息该接口用于查询RDS实例跨地域备份的库表信息。
DescribeCrossRegionBackups查询某RDS实例跨地域数据备份文件列表该接口用于查询某RDS实例跨地域数据备份文件列表。
DescribeCrossRegionLogBackupFiles查询跨地域日志备份文件列表该接口用于查询跨地域日志备份文件列表。
DescribeAvailableCrossRegion查询可以进行跨地域备份的目的地域该接口用于查询所选地域当前可以进行跨地域备份的目的地域。
DescribeCrossRegionBackupDBInstance查询开启跨地域备份实例该接口用于查询所选地域的哪些实例开启了跨地域备份，以及这些实例的跨地域备份设置。
CheckCreateDdrDBInstance预检查实例是否可以进行跨地域恢复该接口用于预检查某RDS实例是否可以用跨地域备份集进行跨地域恢复。

监控

API标题API概述
ModifyDBInstanceMetrics修改RDS PostgreSQL展示的监控指标项该接口用于变更RDS PostgreSQL实例展示的增强监控指标。
DescribeResourceUsage查看实例的空间利用信息该接口用于查询RDS实例的空间使用信息。
DescribeDBInstancePerformance查询实例性能数据该接口用于查询实例性能数据。
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概述
ModifyActiveOperationTasks修改多个主动运维任务切换时间该接口用于修改RDS实例计划内运维任务的切换时间。
DescribeActiveOperationTasks查询多个主动运维任务信息该接口用于查看RDS实例的计划内运维任务详情。

PostgreSQL一键上云

API标题API概述
CreateCloudMigrationPrecheckTask创建RDS PostgreSQL一键上云前检查任务该接口用于创建RDS PostgreSQL一键上云前检查任务。
CreateCloudMigrationTask创建RDS PostgreSQL迁移上云任务该接口用于创建RDS PostgreSQL迁移上云任务。
DescribeCloudMigrationPrecheckResult查询RDS PostgreSQL一键上云前检查报告该接口用于查询一键上云前检查报告详细信息。
DescribeCloudMigrationResult查询RDS PostgreSQL迁移上云任务详情该接口用于查询RDS PostgreSQL迁移上云任务详情。
ActivateMigrationTargetInstanceRDS 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。

其他

API标题API概述
主机主机
DescribeDedicatedHostGroups查询RDS主机组信息查询RDS专属集群信息。
DescribeDedicatedHosts查询RDS主机组内的主机信息查询专属集群内的主机信息。
MigrateDBInstance迁移主机组内的RDS实例调用MigrateDBInstance接口迁移专属集群内的RDS实例。
RebuildDBInstance将RDS主机组内实例的备实例重建调用RebuildDBInstance接口重建专属集群中的RDS备实例。
MigrateConnectionToOtherZone迁移RDS实例至其他可用区该接口用于迁移RDS实例的可用区。
CheckServiceLinkedRole查询是否已创建服务关联角色（SLR）该接口用于查看是否已创建服务关联角色（SLR）。
DescribeDBMiniEngineVersions查询可使用的内核版本列表该接口用于查询可用的MySQL或PostgreSQL小版本列表。
DescribeDBInstanceEncryptionKey查询云盘加密状态及密钥详情查询RDS实例是否开启了云盘加密，以及密钥详情。
DescribeRegionInfos查询可见地域列表该接口用于获取地域列表。
DescribeDBInstanceNetInfoForChannel查询实例网络信息该接口用于查询RDS实例的所有连接地址信息。
DescribeHistoryTasks查询历史运维任务该接口用于获取历史任务记录，支持创建时间30天内的任务。
DescribeClassDetails查询规格详情该接口用于通过规格代码查询规格详情。
DescribeKmsAssociateResources查询KMS指定资源是否关联RDS实例该接口用于查询KMS的指定资源是否关联了RDS实例。

停止维护的接口

API标题API概述
数据库性能优化数据库性能优化
CreateDiagnosticReport创建诊断报告该接口用于创建诊断报告。
DescribeDiagnosticReportList查询诊断报告列表该接口用于查询诊断报告列表。
ModifyDBInstanceProxyConfiguration设置数据库代理调用ModifyDBInstanceProxyConfiguration接口设置数据库代理，已下线。
ModifyDBInstanceConnectionMode开启或关闭数据库代理开启或关闭数据库代理，已下线。
DestroyDBInstance销毁实例该接口用于销毁回收站中的RDS实例。
DescribeTasks查询迁移结果调用DescribeTasks接口查询RDS实例正在进行中的任务。
DescribeDBInstancesForClone获取克隆数据库实例调用DescribeDBInstancesForClone查看实例列表。
DescribeDBInstancesByPerformance按性能获取数据库实例调用DescribeDBInstancesByPerformance接口查询实例性能。
DescribeDBInstanceDetail获取数据库实例详细信息调用DescribeDBInstanceDetail接口查询实例详情。
DescribeRdsResourceSettings获取RDS资源设置此API已废弃，不再使用。
DescribeDBInstancesAsCsv按CSV文件格式查询实例列表该接口用于查询实例列表。
SwitchGuardToMasterInstance将灾备实例切换为独立的主实例该接口用于将灾备实例切换成主实例。
DescribeDBInstancePromoteActivity查询实例命中的促销活动该接口已下线，暂无法使用。
DescribeBackupDatabase查询备份集数据库列表查询备份集下的数据库列表，已下线。
CopyDatabase复制数据库复制数据库SQL Server 2008 R2版，已下线。
文档推荐
  • 本页导读 （1）
文档反馈