发布与管理AgentAPI
更新时间:2026-09-21
概述
Agent API 创建后需要发布才能对外提供服务。本文介绍 Agent API 的查看、发布、下线、编辑、删除、详情查看与消费者认证管理操作。
查看 API 列表
进入目标实例的 API 管理 > Agent API 查看列表。
| 列 | 说明 |
|---|---|
| API 名称/ID | API 标识。单击名称可进入 API 详情页。 |
| 发布状态 | 已发布(PUBLISHED)/ 已下线(OFFLINE)。 |
| 路径 | 路由的匹配路径。 |
| 请求协议 | API 的请求协议(HTTP / WebSocket),支持按协议筛选。 |
| 优先级 | API 的匹配优先级(0-9999,0 为最高)。 |
| 关联 Agent 服务 | API 归属的服务信息。 |
| 关联后端数量 | API 绑定的后端数量。 |
| 更新时间 | API 最近一次的更新时间。 |
| 操作 | 提供「发布」「下线」「编辑」「删除」入口。 |
发布 API
- 在 API 列表中找到目标 API,单击操作列的 发布。
- 发布成功后,发布状态变为「已发布」,API 开始对外提供服务。
下线 API
- 在 API 列表中找到目标 API,单击操作列的 下线。
- 下线后该 API 立即停止对外服务,通过该路由的请求将匹配失败。
注意:下线操作会立即影响线上调用方,请提前通知调用方或确认流量已迁移。WebSocket API 下线会中断已建立的长连接,Agent 多轮会话可能被打断。
编辑 API
- 在 API 列表中对目标 API 单击 编辑。
- 修改配置后保存,需重新 发布 才能生效。
删除 API
在 API 列表中对不再使用的 API 执行 删除,二次确认后完成删除。
注意:删除后 API 立即停止服务且不可恢复,请谨慎操作。
查看 API 详情
单击 API 名称进入详情页,可查看:
- 基本信息:API 名称、API 标识、请求协议、所属服务信息、所属网关实例信息。
- 匹配规则:请求方法、路径与匹配方式、请求头、请求参数、优先级等匹配条件。
- 后端服务:该 API 绑定的 Agent 后端信息。
查看请求处理链路
API 详情页提供图形化的请求处理链路,自左向右展示:
Plain Text
1API(path/method/请求头/请求query)→ 安全防护 → 策略与插件 → 后端
| 节点 | 展示内容 |
|---|---|
| API | 请求入口的匹配条件:Path、Method、Header、Query。 |
| 安全防护 | 该 API 的消费者认证开启状态。 |
| 策略与插件 | 按生效顺序编号展示作用在该 API 上的策略与插件,并标注「策略」「系统插件」「自定义插件」标签。 |
| 后端 | 该 API 转发的后端信息。 |
在「策略与插件」节点中单击某项配置,右侧弹出抽屉可进行局部修改:策略仅支持编辑,插件支持编辑与卸载。继承自实例的插件不支持在此卸载,需前往实例详情的插件管理操作。
管理消费者认证
API 详情提供 消费者认证 标签页,包含「所属服务」(只读继承)与「API」(可编辑)两个区域。
在 API 区域可执行以下操作:
| 操作 | 说明 |
|---|---|
| 开启消费者认证 | 打开开关后在弹窗中选择认证方式(API_KEY / AK_SK),确认后开启。开启后该 API 的流量默认全部拒绝,仅放行已绑定且启用的消费者。 |
| 关闭消费者认证 | 关闭开关,二次确认提示「关闭后,所有流量将放行,已绑定的消费者不会被删除」。 |
| 绑定消费者 | 认证开启状态下可绑定消费者;未开启认证时绑定入口不可用。 |
| 禁用/启用消费者 | 禁用后该消费者立即失效,原认证凭证将无法调用 API;启用后立即恢复。 |
| 解绑 | 解除该消费者与当前 API 的绑定关系。 |
消费者列表展示消费者名称/ID、状态、备注、更新时间与操作列,支持按名称/ID 搜索与按状态筛选。
说明:API 侧开启认证后优先级高于所属服务,完整的生效优先级说明详见授权管理。
相关文档
评价此篇文章
