引用密钥

密钥可被应用于消费者与插件,用于替代原有的明文凭证信息,防止凭证泄露。本文介绍如何在相关资源中引用密钥。

前提条件

已创建密钥,如尚未创建密钥,参考创建密钥

重要

支持在云原生API网关2.1.10及以上版本中引用密钥。

在消费者中引用密钥

  1. 前往 云原生API网关控制台,在左侧导航栏选择消费者,在顶部菜单栏选择地域。

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

    说明

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

在插件中引用密钥

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

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

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

查看密钥的引用详情

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