为使白名单管理更加高效和便捷,云数据库 MySQL 版升级了白名单机制,提供了新接口进行白名单的管理。新老接口的功能说明如下所示。
老版本(v1)
| 功能 | 接口 |
|---|---|
| 查看白名单列表 | ListDBInstanceIPLists |
| 创建白名单 | CreateDBInstanceIPList |
| 修改白名单 | ModifyDBInstanceIPList |
| 删除白名单 | DeleteDBInstanceIPList |
新版本(v2)
| 功能 | 接口 |
|---|---|
| 查看白名单列表 | DescribeAllowLists |
| 查看白名单详情 | DescribeAllowListDetail |
| 创建白名单 | CreateAllowList |
| 修改白名单 | ModifyAllowList |
| 绑定白名单 | AssociateAllowList |
| 解绑白名单 | DisassociateAllowList |
| 删除白名单 | DeleteAllowList |
| 升级白名单版本 | UpgradeAllowListVersion |
在新版本接口发布后,老版本接口会被逐步废弃,不再支持调用。针对老版本接口的使用情况,需要进行相应的适配工作。
说明
通过调用 DescribeDBInstance 接口,判断返回参数的 AllowListVersion 字段的返回值,可以判断使用的白名单版本。
v1,则表示是老版本。v2,则表示是新版本。| 场景 | 使用老版本接口 | 使用新版本接口 |
|---|---|---|
| 新建实例 | 1. 调用 CreateDBInstance 接口创建实例。 2. 调用 ModifyDBInstanceIPList 修改白名单。 3. 调用 ListDBInstanceIPLists 查看白名单是否正确。 | 1. 调用 CreateDBInstance 接口创建实例。 2. 调用 CreateAllowList 和 AssociateAllowList 接口新建白名单并绑定,或者直接调用 AssociateAllowList 接口绑定一个已经存在的白名单。 3. 调用 DescribeAllowLists 接口查看绑定的白名单。 |
修改白名单 | 调用ModifyDBInstanceIPList接口修改白名单。 | 调用 ModifyAllowList 接口修改白名单。 说明 对白名单的修改会影响绑定了这个白名单的所有实例。 |
删除白名单。 | 调用 DeleteDBInstanceIPList 接口删除实例的白名单。 | 调用 DisassociateAllowList 接口与白名单解除绑定。如需彻底删除白名单,需要调用 DeleteAllowList 接口实现。 说明 对白名单的删除会影响绑定了这个白名单的所有实例,删除前需要解除该白名单和实例的绑定。 |
说明
如果在业务中管理的实例既使用的有老版本接口,又有新版本接口,则业务代码需要同时对两个版本的接口进行兼容。