# UA Restriction 配置选项

ua-restriction 插件通过 User-Agent 白名单或黑名单限制对上游资源的访问，防止 Web 爬虫造成过载并提高 API 安全性。<!-- --> <!-- -->配置涵盖插件参数。

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

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

* bypass\_missing

  boolean

  默认值：`false`

  ***

  如果为 true，则在缺少 `User-Agent` 请求头时绕过 User-Agent 限制检查。

* allowlist

  array\[string]

  ***

  允许的 User-Agent 列表。支持正则表达式。

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

* denylist

  array\[string]

  ***

  拒绝的 User-Agent 列表。支持正则表达式。

  在 API7 企业版 3.9.19、3.10.7 和 APISIX 3.19.0 中，插件会分别评估重复的 `User-Agent` 请求头。任何值匹配拒绝列表时，请求都会以 HTTP 403 拒绝；允许的值不能覆盖被拒绝的值。

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

* message

  string

  默认值：`Not allowed`

  ***

  当 User-Agent 被拒绝访问时返回的消息。
