# IP Restriction 配置选项

ip-restriction 插件根据 IP 地址白名单或黑名单限制对上游资源的访问，从而提高 API 安全性。<!-- --> <!-- -->配置涵盖插件参数。

## 参数[​](#参数 "参数的直接链接")

请参阅插件[通用配置](https://docs.apiseven.com/apisix/reference/plugin-common-configurations.md)，了解所有插件通用的配置选项。

* whitelist

  array\[string]

  ***

  白名单 IP 列表。支持 IPv4、IPv6 和 CIDR 格式。

  `whitelist` 和 `blacklist` 必须至少配置其中之一，但不能同时配置。

* blacklist

  array\[string]

  ***

  黑名单 IP 列表。支持 IPv4、IPv6 和 CIDR 格式。

  `whitelist` 和 `blacklist` 必须至少配置其中之一，但不能同时配置。

* message

  string

  默认值：`Your IP address is not allowed`

  ***

  当 IP 地址被拒绝访问时返回的消息。

* response\_code

  integer

  默认值：`403`

  有效值：

  介于 403 和 404 之间（含边界值）

  ***

  因 IP 地址限制拒绝请求时返回的 HTTP 响应码。自 API7 企业版 3.10.3 起可用。
