You need to enable JavaScript to run this app.
导航
2018-01-01 版本 Open API 将于 2025 年 04 月 22 日停止服务
最近更新时间:2025.04.02 16:36:45首次发布时间:2025.04.02 16:36:45
我的收藏
有用
有用
无用
无用

为提供更好的使用体验,云数据库 PostgreSQL 版将停止 2018-01-01 版本 Open API 的对外服务,仅使用 2022-01-01 版本 Open API 继续对外服务。

地域与停服时间

地域停服时间
亚太东南(雅加达)2025 年 04 月 08 日 19 时 30 分(北京时间)
中国香港2025 年 04 月 15 日 19 时 30 分(北京时间)
亚太东南(柔佛)2025 年 04 月 16 日 19 时 30 分(北京时间)
华南1(广州)2025 年 04 月 17 日 19 时 30 分(北京时间)
华东2(上海)2025 年 04 月 21 日 19 时 30 分(北京时间)
华北2(北京)2025 年 04 月 22 日 19 时 30 分(北京时间)

参考信息

云数据库 PostgreSQL 版于 2023 年 11 月 15 日发布了 2022-01-01 版本 Open API。经过持续迭代,2022-01-01 版本 Open API 已经覆盖了全局管理、实例管理、数据库管理、账号管理、Schema 管理、连接管理、参数管理、备份恢复、日志管理和数据安全等多个方面。截止 2025 年 04 月 01 日,2022-01-01 版本的接口数量已达到 63 个,并仍在持续迭代中。云数据库 PostgreSQL 版也为 2022-01-01 版本 Open API 发布了 SDK,详细信息见 SDK 概述
自 2022-01-01 版本 Open API 发布后,2018-01-01 版本 Open API 已经停止迭代,不再增加新的功能。相较于 2022-01-01 版本,2018-01-01 版本的接口数量仍维持在 22 个,只覆盖了全局管理、实例管理、数据库管理、账号管理、Schema 管理和数据安全等若干方面。
为了获得更全面的功能和更好的使用体验,我们强烈建议您使用 2022-01-01 版本 Open API。如您已经使用了 2018-01-01 版本的 Open API,可参考如下表所示的对应关系,进行替换和适配。

分类功能2022-01-012018-01-01接口差异与适配建议

全局管理

查询可用地域列表。

DescribeRegions

ListRegions

Action、 Version、Host、请求参数、返回参数有变化。

  • 2018-01-01 Host:rds.volcengineapi.com
  • 2022-01-01 Host:open.volcengineapi.com

查询可用区列表。

DescribeAvailabilityZones

ListZones

Action、 Version、Host、请求参数、返回参数有变化。

  • 2018-01-01 Host:rds.volcengineapi.com
  • 2022-01-01 Host:open.volcengineapi.com

实例管理

创建实例。

CreateDBInstance

CreateDBInstance

Version、Host、请求参数、返回参数有变化。

  • 2018-01-01 Host:rds.volcengineapi.com
  • 2022-01-01 Host:open.volcengineapi.com

查询实例列表。

DescribeDBInstances

ListDBInstances

Action、 Version、Host、请求参数、返回参数有变化。

  • 2018-01-01 Host:rds.volcengineapi.com
  • 2022-01-01 Host:open.volcengineapi.com

查询实例详细信息。

DescribeDBInstanceDetail

DescribeDBInstanceDescribeDBInstanceConnection

Action、 Version、Host、请求参数、返回参数有变化。

  • 2018-01-01 Host:rds.volcengineapi.com
  • 2022-01-01 Host:open.volcengineapi.com
修改实例名称。ModifyDBInstanceName请参考 2022 版本接口的相应文档进行调用。
查询可售卖实例规格。DescribeDBInstanceSpecs请参考 2022 版本接口的相应文档进行调用。
修改实例配置。ModifyDBInstanceSpec请参考 2022 版本接口的相应文档进行调用。

重启实例。

RestartDBInstance

RestartDBInstance

Version、Host、请求参数有变化。

  • 2018-01-01 Host:rds.volcengineapi.com
  • 2022-01-01 Host:open.volcengineapi.com

删除实例。

DeleteDBInstance

DeleteDBInstance

Version、Host 有变化。

  • 2018-01-01 Host:rds.volcengineapi.com
  • 2022-01-01 Host:open.volcengineapi.com
查询实例价格详情。DescribeDBInstancePriceDetail请参考 2022 版本接口的相应文档进行调用。
查询实例差价。DescribeDBInstancePriceDifference请参考 2022 版本接口的相应文档进行调用。
修改实例计费方式。ModifyDBInstanceChargeType请参考 2022 版本接口的相应文档进行调用。
为实例绑定标签。AddTagsToResource请参考 2022 版本接口的相应文档进行调用。
为实例解绑标签。RemoveTagsFromResource请参考 2022 版本接口的相应文档进行调用。
迁移节点至同一地域下的其他可用区。ModifyDBInstanceAvailabilityZone请参考 2022 版本接口的相应文档进行调用。

数据库管理

创建数据库。

CreateDatabase

CreateDatabase

Version、Host、请求参数有变化。

  • 2018-01-01 Host:rds.volcengineapi.com
  • 2022-01-01 Host:open.volcengineapi.com

查询数据库列表。

DescribeDatabases

ListDatabases

Action、 Version、Host、请求参数、返回参数有变化。

  • 2018-01-01 Host:rds.volcengineapi.com
  • 2022-01-01 Host:open.volcengineapi.com
修改数据库 Owner。ModifyDatabaseOwner请参考 2022 版本接口的相应文档进行调用。

删除数据库。

DeleteDatabase

DeleteDatabase

Version、Host 有变化。

  • 2018-01-01 Host:rds.volcengineapi.com
  • 2022-01-01 Host:open.volcengineapi.com

账号管理

创建账号。

CreateDBAccount

CreateAccount

Action、 Version、Host、请求参数有变化。

  • 2018-01-01 Host:rds.volcengineapi.com
  • 2022-01-01 Host:open.volcengineapi.com

查询账号列表。

DescribeDBAccounts

ListAccounts

Action、 Version、Host、请求参数、返回参数有变化。

  • 2018-01-01 Host:rds.volcengineapi.com
  • 2022-01-01 Host:open.volcengineapi.com
修改数据库账号权限。ModifyDBAccountPrivilege请参考 2022 版本接口的相应文档进行调用。
清空对数据库账号的授权。RevokeDBAccountPrivilege请参考 2022 版本接口的相应文档进行调用。

重置账号的密码。

ResetDBAccount

ResetAccountPassword

Action、 Version、Host 有变化。

  • 2018-01-01 Host:rds.volcengineapi.com
  • 2022-01-01 Host:open.volcengineapi.com

删除账号。

DeleteDBAccount

DeleteAccount

Action、 Version、Host 有变化。

  • 2018-01-01 Host:rds.volcengineapi.com
  • 2022-01-01 Host:open.volcengineapi.com

Schema 管理

创建 Schema。

CreateSchema

CreateSchema

Version、Host、请求参数有变化。

  • 2018-01-01 Host:rds.volcengineapi.com
  • 2022-01-01 Host:open.volcengineapi.com

查询 Schema 列表。

DescribeSchemas

ListSchema

Action、 Version、Host、请求参数有变化。

  • 2018-01-01 Host:rds.volcengineapi.com
  • 2022-01-01 Host:open.volcengineapi.com

修改 Schema 的 owner。

ModifySchemaOwner

ModifySchemaOwner

Version、Host 有变化。

  • 2018-01-01 Host:rds.volcengineapi.com
  • 2022-01-01 Host:open.volcengineapi.com

删除 Schema。

DeleteSchema

DeleteSchema

Version、Host 有变化。

  • 2018-01-01 Host:rds.volcengineapi.com
  • 2022-01-01 Host:open.volcengineapi.com
连接管理创建连接终端。CreateDBEndpoint请参考 2022 版本接口的相应文档进行调用。
修改连接终端名称。ModifyDBEndpointName请参考 2022 版本接口的相应文档进行调用。
设置实例是否开启全局只读。ModifyDBInstanceConfig请参考 2022 版本接口的相应文档进行调用。
修改终端读权重分配模式,以及自定义权重配比。ModifyDBEndpointReadWeight请参考 2022 版本接口的相应文档进行调用。
开启或关闭读写分离。ModifyDBEndpointReadWriteFlag请参考 2022 版本接口的相应文档进行调用。
修改终端只读延迟阈值ModifyDBEndpointReadWriteDelayThreshold请参考 2022 版本接口的相应文档进行调用。
修改实例私网连接地址的端口和前缀。ModifyDBEndpointAddress请参考 2022 版本接口的相应文档进行调用。
修改实例 DNS。ModifyDBEndpointDNS请参考 2022 版本接口的相应文档进行调用。
删除连接终端。DeleteDBEndpoint请参考 2022 版本接口的相应文档进行调用。
创建公网地址。CreateDBEndpointPublicAddress请参考 2022 版本接口的相应文档进行调用。
删除公网地址。DeleteDBEndpointPublicAddress请参考 2022 版本接口的相应文档进行调用。
参数管理查询实例参数。DescribeDBInstanceParameters请参考 2022 版本接口的相应文档进行调用。
修改实例参数。ModifyDBInstanceParameters请参考 2022 版本接口的相应文档进行调用。
查询实例参数修改历史。DescribeDBInstanceParametersLog请参考 2022 版本接口的相应文档进行调用。
备份恢复创建备份。CreateBackup请参考 2022 版本接口的相应文档进行调用。
查询备份列表。DescribeBackups请参考 2022 版本接口的相应文档进行调用。
查询备份策略。DescribeBackupPolicy请参考 2022 版本接口的相应文档进行调用。
修改备份策略。ModifyBackupPolicy请参考 2022 版本接口的相应文档进行调用。
查询实例备份可恢复的时间范围。DescribeRecoverableTime请参考 2022 版本接口的相应文档进行调用。
查询已删除实例备份。DescribeDetachedBackups请参考 2022 版本接口的相应文档进行调用。
恢复到新实例。RestoreToNewInstance请参考 2022 版本接口的相应文档进行调用。
查询实例的复制槽。DescribeSlots请参考 2022 版本接口的相应文档进行调用。
删除复制槽。DeleteSlot请参考 2022 版本接口的相应文档进行调用。
日志管理查询实例主备切换日志。DescribeFailoverLogs请参考 2022 版本接口的相应文档进行调用。

数据安全

查看指定地域下的白名单列表。

DescribeAllowLists

ListDBInstanceIPLists

Action、 Version、Host、请求参数、返回参数有变化。

  • 2018-01-01 Host:rds.volcengineapi.com
  • 2022-01-01 Host:open.volcengineapi.com
查看白名单详情。DescribeAllowListDetail请参考 2022 版本接口的相应文档进行调用。

创建白名单。

CreateAllowList

CreateDBInstanceIPList

Action、 Version、Host、请求参数、返回参数有变化。

  • 2018-01-01 Host:rds.volcengineapi.com
  • 2022-01-01 Host:open.volcengineapi.com

修改白名单。

ModifyAllowList

ModifyDBInstanceIPList

Action、 Version、Host、请求参数、返回参数有变化。

  • 2018-01-01 Host:rds.volcengineapi.com
  • 2022-01-01 Host:open.volcengineapi.com
绑定白名单。AssociateAllowList请参考 2022 版本接口的相应文档进行调用。
解绑白名单。DisassociateAllowList请参考 2022 版本接口的相应文档进行调用。

删除白名单。

DeleteAllowList

DeleteDBInstanceIPList

Action、 Version、Host、请求参数、返回参数有变化。

  • 2018-01-01 Host:rds.volcengineapi.com
  • 2022-01-01 Host:open.volcengineapi.com
将多个实例的白名单合并生成为一个新的白名单。UnifyNewAllowList请参考 2022 版本接口的相应文档进行调用。
升级白名单版本。UpgradeAllowListVersion请参考 2022 版本接口的相应文档进行调用。

其他

如您有任何问题,可以登录火山引擎官网创建工单进行咨询。