文档中心

API 概览

最近更新时间：2024.04.28 11:36:22

首次发布时间：2023.11.15 22:39:51

本文汇总云数据库 PostgreSQL 版提供的 Open API 接口。

说明

单个地域下，云数据库 PostgreSQL 版的 API 流控限制为 20 次/秒，即单个火山引擎账号每秒钟调用单个 API 接口的次数不可超过 20。若超过该限制，会导致 API 请求执行失败，并提示 AccountFlowLimitExceeded 报错。

全局管理

接口	接口说明
DescribeRegions	调用 DescribeRegions 接口查询可用地域列表。
DescribeAvailabilityZones	调用 DescribeAvailabilityZones 接口查询可用区列表。

接口	接口说明
CreateDBInstance	调用 CreateDBInstance 接口创建实例。
DescribeDBInstances	调用 DescribeDBInstances 接口查询实例列表。
DescribeDBInstanceDetail	调用 DescribeDBInstanceDetail 接口查询实例详细信息。
ModifyDBInstanceName	调用 ModifyDBInstanceName 接口修改实例名称。
DescribeDBInstanceSpecs	调用 DescribeDBInstanceSpecs 接口查询可售卖实例规格。
ModifyDBInstanceSpec	调用 ModifyDBInstanceSpec 接口修改实例配置。
RestartDBInstance	调用 RestartDBInstance 接口重启实例。
DeleteDBInstance	调用 DeleteDBInstance 接口删除实例。
DescribeDBInstancePriceDetail	调用 DescribeDBInstancePriceDetail 接口查询实例价格详情。
DescribeDBInstancePriceDifference	调用 DescribeDBInstancePriceDifference 接口查询实例差价。
ModifyDBInstanceChargeType	调用 ModifyDBInstanceChargeType 接口修改实例计费方式。
AddTagsToResource	调用 AddTagsToResource 接口为实例绑定标签。
RemoveTagsFromResource	调用 RemoveTagsFromResource 接口为实例解绑标签。
ModifyDBInstanceAvailabilityZone	调用 ModifyDBInstanceAvailabilityZone 接口迁移节点至同一地域下的其他可用区。

接口	接口说明
CreateDatabase	调用 CreateDatabase 接口创建数据库。
DescribeDatabases	调用 DescribeDatabases 接口查询数据库列表。
ModifyDatabaseOwner	调用 ModifyDatabaseOwner 接口修改数据库 Owner。
DeleteDatabase	调用 DeleteDatabase 接口删除数据库。

接口	接口说明
CreateDBAccount	调用 CreateDBAccount 接口创建账号。
DescribeDBAccounts	调用 DescribeDBAccounts 接口查询账号列表。
ModifyDBAccountPrivilege	调用 ModifyDBAccountPrivilege 接口修改数据库账号权限。
RevokeDBAccountPrivilege	调用 RevokeDBAccountPrivilege 接口清空对数据库账号的授权。
ResetDBAccount	调用 ResetDBAccount 接口重置账号的密码。
DeleteDBAccount	调用 DeleteDBAccount 接口删除账号。

接口	接口说明
CreateSchema	调用 CreateSchema 接口创建 Schema。
DescribeSchemas	调用 DescribeSchemas 接口查询 Schema 列表。
ModifySchemaOwner	调用 ModifySchemaOwner 接口修改 Schema 的 owner。
DeleteSchema	调用 DeleteSchema 接口删除 Schema。

接口	接口说明
CreateDBEndpoint	调用 CreateDBEndpoint 接口创建连接终端。
ModifyDBEndpointName	调用 ModifyDBEndpointName 接口修改连接终端名称。
ModifyDBInstanceConfig	调用 ModifyDBInstanceConfig 接口设置实例是否开启全局只读。
ModifyDBEndpointReadWeight	调用 ModifyDBEndpointReadWeight 接口修改终端读权重分配模式，以及自定义权重配比。
ModifyDBEndpointReadWriteFlag	调用 ModifyDBEndpointReadWriteFlag 接口开启或关闭读写分离。
ModifyDBEndpointReadWriteDelayThreshold	调用 ModifyDBEndpointReadWriteDelayThreshold 接口修改终端只读延迟阈值
ModifyDBEndpointAddress	调用 ModifyDBEndpointAddress 接口修改实例私网连接地址的端口和前缀。
ModifyDBEndpointDNS	调用 ModifyDBEndpointDNS 接口修改实例 DNS。
DeleteDBEndpoint	调用 DeleteDBEndpoint 接口删除连接终端。
CreateDBEndpointPublicAddress	调用 CreateDBEndpointPublicAddress 接口创建公网地址。
DeleteDBEndpointPublicAddress	调用 DeleteDBEndpointPublicAddress 接口删除公网地址。

接口	接口说明
DescribeDBInstanceParameters	调用 DescribeDBInstanceParameters 接口查询实例参数。
ModifyDBInstanceParameters	调用 ModifyDBInstanceParameters 接口修改实例参数。
DescribeDBInstanceParametersLog	调用 DescribeDBInstanceParametersLog 接口查询实例参数修改历史。

接口	接口说明
CreateBackup	调用 CreateBackup 接口创建备份。
DescribeBackups	调用 DescribeBackups 接口查询备份列表。
DescribeBackupPolicy	调用 DescribeBackupPolicy 接口查询备份策略。
ModifyBackupPolicy	调用 ModifyBackupPolicy 接口修改备份策略。
DescribeRecoverableTime	调用 DescribeRecoverableTime 接口查询实例备份可恢复的时间范围。
DescribeDetachedBackups	调用 DescribeDetachedBackups 接口查询已删除实例备份。
RestoreToNewInstance	调用 RestoreToNewInstance 接口恢复到新实例。

接口	接口说明
DescribeFailoverLogs	调用 DescribeFailoverLogs 接口查询实例主备切换日志。

接口	接口说明
DescribeAllowLists	调用 DescribeAllowLists 接口查看指定地域下的白名单列表。
DescribeAllowListDetail	调用 DescribeAllowListDetail 接口查看白名单详情。
CreateAllowList	调用 CreateAllowList 接口创建白名单。
ModifyAllowList	调用 ModifyAllowList 接口修改白名单。
AssociateAllowList	调用 AssociateAllowList 接口绑定白名单。
DisassociateAllowList	调用 DisassociateAllowList 接口解绑白名单。
DeleteAllowList	调用 DeleteAllowList 接口删除白名单。
UnifyNewAllowList	调用 UnifyNewAllowList 接口将多个实例的白名单合并生成为一个新的白名单。
UpgradeAllowListVersion	调用 UpgradeAllowListVersion 接口升级白名单版本。

接口	接口说明
DescribeAllowLists	调用 DescribeAllowLists 接口查看指定地域下的白名单列表。
DescribeAllowListDetail	调用 DescribeAllowListDetail 接口查看白名单详情。
CreateAllowList	调用 CreateAllowList 接口创建白名单。
ModifyAllowList	调用 ModifyAllowList 接口修改白名单。
AssociateAllowList	调用 AssociateAllowList 接口绑定白名单。
DisassociateAllowList	调用 DisassociateAllowList 接口解绑白名单。
DeleteAllowList	调用 DeleteAllowList 接口删除白名单。
UnifyNewAllowList	调用 UnifyNewAllowList 接口将多个实例的白名单合并生成为一个新的白名单。
UpgradeAllowListVersion	调用 UpgradeAllowListVersion 接口升级白名单版本。

全局管理

实例管理

数据库管理

账号管理

Schema 管理

连接管理

参数管理

备份与恢复

日志管理

数据安全