升级白名单--云数据库 PostgreSQL 版-火山引擎

文档中心

导航

升级白名单

最近更新时间：2024.05.06 17:28:10首次发布时间：2024.04.28 11:36:22

本文介绍为云数据库 PostgreSQL 版实例升级白名单管理功能的操作步骤。

背景信息

为使白名单管理更加高效和便捷，云数据库 PostgreSQL 版于 2024 年 4 月 25 日全面上线了新版的白名单管理功能。新版的白名单管理功能实现了白名单与实例的解耦，白名单与实例相互独立，一个白名单可以绑定到多个实例，一个实例也可以绑定多个白名单，支持批量管理，更加贴合实际业务场景。例如，可以按照应用服务器来组织白名单，增加一台应用服务器只需要调用一次 Open API，即可达到批量管理多个实例的效果。

新版白名单管理功能提供了新的 Open API 接口。新老版本的白名单 Open API 不能互通，在新版本接口发布后，老版本接口会被逐步废弃，不再支持调用。

功能	接口（v2）	接口（v1）
查看白名单列表	DescribeAllowLists	ListDBInstanceIPLists
查看白名单详情	DescribeAllowListDetail	无
创建白名单	CreateAllowList	CreateDBInstanceIPList
修改白名单	ModifyAllowList	ModifyDBInstanceIPList
绑定白名单	AssociateAllowList	无
解绑白名单	DisassociateAllowList	无
删除白名单	DeleteAllowList	DeleteDBInstanceIPList
合并生成白名单	UnifyNewAllowList	无
升级白名单版本	UpgradeAllowListVersion	无

升级说明

如果在控制台中实例的数据安全页签下看到以下提示，需要为实例升级白名单管理功能。关于升级白名单管理功能的详细信息，请参见升级白名单管理功能。

说明

您可根据业务需要决定是否升级白名单管理功能和升级时间。在升级白名单管理功能前，请参照添加 IP 白名单分组管理白名单分组。

如果您使用了 Open API ，需要在升级白名单管理功能并对业务代码做修改和适配。新老版本白名单差异请参见新老版本白名单接口使用方式差异。
如果在使用新版白名单管理功能过程中，遇到“The AllowListVersion is not valid.”的提示，可能是因为调用的接口版本与实例的白名单管理功能版本不一致导致，请参照新老版本白名单接口使用方式差异进行改造。

升级白名单管理功能

可通过控制台或 Open API 完成白名单管理功能的升级。

通过控制台
1. 登录云数据库 PostgreSQL 版控制台。
2. 在顶部菜单栏的左上角，选择实例所属的项目和地域。
  说明
  如未设置实例的所属项目，本操作应选择项目为账号全部资源。
3. 在左侧导航栏单击实例列表。
4. 在实例列表页面，单击目标实例名称。
5. 在页面上方，单击数据安全页签。
6. 单击数据安全页签下横幅消息的立即升级。
7. 在弹出的立即升级对话框中，单击确定。
  说明
  - 升级完成后，实例之前绑定的所有 IP 白名单组中的 IP，会合并为一个名为“实例ID的白名单”的白名单，并与实例绑定。
  - 升级白名单管理功能的过程中，会对 IP 地址进行规范化处理，将未采用 CIDR 格式的 IP 地址统一规范为标准 CIDR 格式表示（/32）。例如，原地址为 127.0.0.1，升级后会被规范为 127.0.0.1/32。已采用了 CIDR 格式表述的 IP 地址或地址段不做处理。
通过 Open API
调用 UpgradeAllowListVersion 接口，即可完成升级。

新老版本白名单接口使用方式差异

如果您使用了 Open API ，需要在升级白名单管理功能后，选择合适的时机，对业务代码做修改和适配。

场景	使用老版本接口	使用新版本接口
新建实例	调用 CreateDBInstance 接口创建实例。调用 ModifyDBInstanceIPList 修改白名单调用 ListDBInstanceIPLists 查看白名单是否正确。	调用 CreateDBInstance 接口创建实例。调用 CreateAllowList 和 AssociateAllowList 接口新建白名单并绑定，或者直接调用 AssociateAllowList 接口绑定一个已经存在的白名单。调用 DescribeAllowLists 接口查看绑定的白名单。
修改白名单	调用 ModifyDBInstanceIPList 接口修改白名单。	调用 ModifyAllowList 接口修改白名单。说明对白名单的修改会影响绑定了这个白名单的所有实例。
删除白名单	调用 DeleteDBInstanceIPList 接口删除实例的白名单。	调用 DisassociateAllowList 接口与白名单解除绑定。如需彻底删除白名单，需要调用 DeleteAllowList 接口实现。说明对白名单的删除会影响绑定了这个白名单的所有实例，删除前需要解除该白名单和实例的绑定。

API	描述
DescribeAllowLists	调用 DescribeAllowLists 接口查看指定地域下的白名单列表。
DescribeAllowListDetail	调用 DescribeAllowListDetail 接口查看白名单详情。
CreateAllowList	调用 CreateAllowList 接口创建白名单。
ModifyAllowList	调用 ModifyAllowList 接口修改白名单。
AssociateAllowList	调用 AssociateAllowList 接口绑定白名单。
DisassociateAllowList	调用 DisassociateAllowList 接口解绑白名单。
DeleteAllowList	调用 DeleteAllowList 接口删除白名单。
UpgradeAllowListVersion	调用 UpgradeAllowListVersion 接口升级白名单版本。

云数据库 PostgreSQL 版

背景信息

升级说明

升级白名单管理功能

新老版本白名单接口使用方式差异

相关 API