跳到主要内容

参数​

请参阅 插件通用配置 了解所有插件可用的配置选项。

凭据​

以下是可在凭据上配置的插件属性。

  • key

    string

    必填

    标识消费者凭据的唯一密钥。密钥在存储到 etcd 之前会使用 AES 进行加密。你也可以将其存储在环境变量中并使用 env:// 前缀引用，或者存储在密钥管理器（如 HashiCorp Vault 的 KV 密钥引擎）中并使用 secret:// 前缀引用。更多信息请参见密钥。

路由或服务​

以下是可用于 路由 (Routes) 或 服务 (Services) 配置的插件属性。

  • header

    string

    默认值：apikey

    用于获取密钥的请求头。

  • query

    string

    默认值：apikey

    用于获取密钥的查询字符串。优先级低于请求头。

  • hide_credentials

    boolean

    默认值：false

    如果为 true，则在转发到上游前删除已配置的凭证请求头和查询参数。在回退到 anonymous_consumer 前，网关还会删除无效凭证。无效凭证删除行为自 API7 企业版 3.9.14、3.10.1 和 APISIX 3.17.0 起引入。

  • anonymous_consumer

    string

    匿名消费者名称。如果配置，则允许匿名用户绕过认证。更多详细信息，请参见 针对匿名消费者的速率限制。

  • realm

    string

    默认值：key

    因身份认证失败而返回 401 Unauthorized 响应时，WWW-Authenticate 响应头中的 Realm。例如：

    • 如果 realm 设置为 key-auth，401 响应将包含以下响应头：

      WWW-Authenticate: apikey realm="key-auth"

    • 如果未配置 realm，401 响应将包含以下响应头：

      WWW-Authenticate: apikey realm="key"

    此参数在 API7 企业版 3.9.2 及更高版本，以及 Apache APISIX 3.15.0 及更高版本中可用。