引用密钥

前提条件

已创建密钥，如尚未创建密钥，参考创建密钥。

在消费者中引用密钥

1. 前往 AI 网关控制台，在左侧导航栏选择消费者，在顶部菜单栏选择地域。

2. 单击创建消费者，在创建消费者页面，配置消费者名称，认证方式选择 API Key，生成方式选择引用密钥，在绑定密钥选项中选择已有密钥。

   说明

   消费者凭证信息中仅 API key 认证方式支持引用密钥。

在 AI 服务中引用密钥

1. 前往 AI 网关控制台，在左侧导航栏选择实例，在顶部菜单栏选择地域。

2. 单击目标实例 ID，选择左侧导航栏服务，然后单击创建服务。

3. 在创建服务面板中，服务来源选择AI服务，在大模型配置中，生成方式选择引用密钥，API Key 选择已有密钥。

在 Agent 服务中引用密钥

1. 前往 AI 网关控制台，在左侧导航栏选择实例，在顶部菜单栏选择地域。

2. 单击目标实例 ID，选择左侧导航栏的服务，然后单击创建服务。

3. 在创建服务面板中，服务来源选择Agent 服务，生成方式选择引用密钥，API Key 选择已有密钥名称。

在 MCP 服务中引用密钥

AI 网关直接代理的 MCP 服务支持开启后端认证，在认证配置中，可将凭证直接指定为已有密钥。。

1. 登录 AI 网关控制台，在左侧导航栏选择实例，在顶部菜单栏选择地域。

2. 单击目标实例 ID，创建使用场景为MCP服务直接代理的 MCP 服务，参考：创建网关托管MCP服务。

3. 进入 MCP 服务详情页，在基本信息页单击配置后端服务凭证开启认证状态，参考以下内容完成相关配置。

   1. 认证方式：选择 API Key。

   2. 凭证来源：自定义 HTTP Header。

   3. Header：携带凭证的 Header 名称。

   4. 生成方式：选择引用密钥。

   5. 凭证：选择已有的密钥名称。

在插件中引用密钥

在插件配置中，可以使用$ref{secretName}语法引用已创建的密钥，其中secretName为密钥名称，下面是 Key-Auth 插件的配置示例：

credentials: 
# 引用名为secretName的密钥
- $ref{secretName}
keys:
- apikey
- x-api-key

通过上述配置，可直接使用secretName密钥访问 AI 网关，官方插件与自定义插件均支持引用密钥。

查看密钥的引用详情

前往 AI 网关控制台，在左侧导航栏选择密钥，在被引用列点击密钥的引用次数，可查看当前密钥被哪些资源引用。