跳到主要内容

参数​

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

凭证 (Credentials)​

以下是可用于 凭证 (Credentials) 配置的插件属性。

  • key

    string

    required

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

路由或服务 (Routes or Services)​

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

  • header

    string

    default: apikey

    获取密钥的 Header。

  • query

    string

    default: apikey

    获取密钥的查询字符串。优先级低于 Header。

  • hide_credentials

    boolean

    default: false

    如果为 true，则不将包含密钥的 Header 或查询字符串传递给上游服务。

  • anonymous_consumer

    string

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

  • realm

    string

    default: key

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

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

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

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

      WWW-Authenticate: apikey realm="key"

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