You need to enable JavaScript to run this app.
导航

接口说明

最近更新时间2022.11.25 21:46:19

首次发布时间2022.09.22 21:18:51

为使白名单管理更加高效和便捷,云数据库 MySQL 版升级了白名单机制,提供了新接口进行白名单的管理。新老接口的功能说明如下所示。

在新版本接口发布后,老版本接口会被逐步废弃,不再支持调用。针对老版本接口的使用情况,需要进行相应的适配工作。

说明

通过调用 DescribeDBInstance 接口,判断返回参数的 AllowListVersion 字段的返回值,可以判断使用的白名单版本。

  • 如果是 v1,则表示是老版本。
  • 如果是 v2,则表示是新版本。
  • 如果您没有使用 Open API ,也没有第三方业务通过 Open API 管理您的实例,则只需在控制台上单击升级即可,不会对业务产生影响。
  • 如果您使用了 Open API ,则需选择合适的时机,对业务代码做如下修改和适配。
    1. 调用 UpgradeAllowListVersion 接口,将所有实例升级到到新版的白名单。
    2. 修改业务代码。
    场景使用老版本接口使用新版本接口
    新建实例1. 调用 CreateDBInstance 接口创建实例。
    2. 调用 ModifyDBInstanceIPList 修改白名单。
    3. 调用 ListDBInstanceIPLists 查看白名单是否正确。
    1. 调用 CreateDBInstance 接口创建实例。
    2. 调用 CreateAllowListAssociateAllowList 接口新建白名单并绑定,或者直接调用 AssociateAllowList 接口绑定一个已经存在的白名单。
    3. 调用 DescribeAllowLists 接口查看绑定的白名单。

    修改白名单

    调用ModifyDBInstanceIPList接口修改白名单。

    调用 ModifyAllowList 接口修改白名单。

    说明

    对白名单的修改会影响绑定了这个白名单的所有实例。

    删除白名单。

    调用 DeleteDBInstanceIPList 接口删除实例的白名单。

    调用 DisassociateAllowList 接口与白名单解除绑定。如需彻底删除白名单,需要调用 DeleteAllowList 接口实现。

    说明

    对白名单的删除会影响绑定了这个白名单的所有实例,删除前需要解除该白名单和实例的绑定。

说明

如果在业务中管理的实例既使用的有老版本接口,又有新版本接口,则业务代码需要同时对两个版本的接口进行兼容。