文档中心

API 网关

最佳实践

JWT Token 迁移 API Key 最佳实践（保留 JWT Token）

API 网关支持使用 JWT 和 API Key 认证鉴权，本文介绍如何在保留 JWT Token 的前提下，在机器学习平台中从 JWT 认证迁移到 API Key 认证。

注意事项

Key Auth 插件支持在服务、路由级别的资源中开启和关闭，插件配置的生效优先级为路由 > 服务。

Key Auth 在消费者中生成，一个消费者最多支持 5 个 API Key。

前提条件

API 网关

已创建网关实例。详情请参见创建实例。

已创建服务，具体操作可参见创建服务。

已创建路由。详情请参见创建路由。

机器学习平台

已经创建在线服务，开启服务 Token 校验。并使用 API 网关的 JWT Token 进行认证鉴权。

操作步骤

步骤一：创建消费者

在顶部导航栏，选择目标地域。

在左侧导航栏选择消费者管理 > 消费者列表，单击创建消费者。

说明

消费者可以用于区分不同部门或业务方。

如果不需要对应多个部门或业务方，创建一个消费者即可。

单击确定，完成配置。

步骤二：生成 API Key

在左侧导航栏选择消费者管理 > 消费者列表。

在消费者列表中，单击目标消费者名称，进入消费者详情页面。

在认证信息区域，单击生成 API Key。

在弹出的对话框内容选择上传已有，并在 API Key 信息文本框内输入原有的 Token。

注意

上传的 Token 信息中不要带 Bearer。

单击确定，生成 API Key 认证信息。

步骤三：启用 Key Auth 插件

在左侧导航栏选择插件管理 > Key Auth插件，单击创建插件，配置插件参数。

生效级别：选择路由级别，并配置插件所属实例、服务和路由。

认证配置：选择 header，并配置来源为 Authorization，表示在请求头中的 Authorization 附带 API Key 认证信息。

消费者：选择已创建的消费者。

其他配置保持缺省。

单击确定，完成配置。

步骤四：关闭 JWT 认证

在机器学习平台中关闭 JWT Token 认证。

登录机器学习平台。

在左侧导航栏选择在线服务，在服务列中选择需要关闭 JWT Token 认证的服务。单击服务名称，进入服务详情。

选择调用指南页签，单击关闭服务 Token 校验。

在 API 网关中关闭 JWT Token 认证。

在左侧导航栏选择服务列表（域名），在服务列表中选择目标服务，单击服务名称，进入服务详情。

选择认证管理页签，在 JWT 认证配置页面中，关闭 JWT Token 认证。

结果验证

查看配置

配置完成后，在插件列表中，选择路由级别页签，查看已配置的 Key Auth 插件，若插件状态为已启用，表示插件生效。

认证测试

在 API 网关实例中开启 Key Auth 插件，并使用消费者生成 API Key 认证信息后。仅携带该认证信息的访问请求，能够通过 API 网关访问到后端 Upstream。

使用 API 网关实例中配置的域名访问服务，同时携带 API Key 认证信息时。

预期访问结果如下。表示可以通过 AI 网关正确访问到后端服务。

常见 FAQ

如何生成多个 API Key

在左侧导航栏选择消费者列表，单击目标消费者名称，进入消费者详情页面。

多次单击生成 API Key，即可在当前消费者中添加多个 API Key。

调用报错 Jwt is not in the form of Header.Payload.Signature with two dots and 3 sections

请在机器学习平台或 API 网关中关闭 JWT Token 认证。

注意

关闭 JWT Token 后，如果仍然调用报错，可尝试重新开启，再关闭 JWT Token 认证。

在机器学习平台中关闭 JWT Token 认证。

登录机器学习平台。

在左侧导航栏选择在线服务，在服务列中选择需要关闭 JWT Token 认证的服务。单击服务名称，进入服务详情。

选择调用指南页签，单击关闭服务 Token 校验。

在 API 网关中关闭 JWT Token 认证。

在左侧导航栏选择服务列表（域名），在服务列表中选择目标服务，单击服务名称，进入服务详情。

选择认证管理页签，在 JWT 认证配置页面中，关闭 JWT Token 认证。

最近更新时间：2025.04.27 19:25:47

这个页面对您有帮助吗？

有用

无用