IP 黑名单和白名单是 API 网关提供的安全防护能力之一。您可以通过配置黑、白名单来拒绝或允许特定 IP 的访问请求。API 网关支持在实例级别、服务级别和路由级别配置 IP 黑名单和白名单，满足精细化的访问控制诉求。本文介绍如何为API 网关设置黑名单和白名单。

前提条件

• 已创建网关实例。详情请参见 创建实例。

• 已创建服务，具体操作可参见 创建服务。

• 已创建路由。详情请参见 创建路由。

使用限制

• 一个资源维度仅支持一个黑白名单插件。

• 同一插件内可以同时定义黑名单和白名单。

• 黑名单和白名单同时生效时，黑名单生效优先级更高。

操作步骤

1. 登录 API 网关控制台。

2. 在左侧导航栏选择 插件管理 > IP 黑白名单插件。

3. 在IP 黑白名单插件页面，单击 创建插件。

4. 在 创建 IP 黑白名单插件 页面，填写参数信息，然后单击 确定。

   

   配置项	说明
   生效级别	选择 IP 黑白名单插件的生效级别，当前支持 实例级别、服务级别 和 路由级别。 实例级别 需进一步选择目标实例。 服务级别 需进一步选择目标服务 路由级别 需进一步选择目标路由。
   备注	输入关于当前 IP 黑白名单插件的备注信息，可以为空。
   IP 黑/白名单	勾选需要配置的 黑名单 和 白名单。 黑名单：禁止特定 IP 访问。在网关场景针对不友好访问执行来源 IP 封禁。 白名单：允许特定 IP 访问。在网关场景只开放受信任来源 IP 访问。
   IP 列表	输入合法的 IPv4 CIDR 的 IP。支持输入多个，用分号(;)或回车隔开。
   自定义获取 IP	是否开启自定义获取 IP。 注意 X-Forward-For 转发过程中存在被篡改的风险，API 网关无法检验 X-Forward-For 内容的可信度。 IP 获取方式：当前只支持 基于 X-Forward-For。 拦截位置：在多层转发链路上选择进行访问控制的 IP 位置，IP 信息来自 X-Forward-For。