API概述
更新时间:2026-09-21
什么是 API
API(路由)是网关上对外暴露的一条访问路径,定义了请求如何匹配(路径、方法、请求头、请求参数)并按照设定的策略转发到一个或多个后端。
API 类型
API 网关专享版支持三类 API,各类型的创建、发布管理与监控能力按模块分别说明:
| API 类型 | 归属服务 | 说明 | 文档 |
|---|---|---|---|
| 基础 API | 基础服务 | 通用路由,支持 HTTP 与 WebSocket 两种请求协议,支持超时、URL 重写、重试等高级策略,后端支持单服务实例与多服务实例(按权重)。 | 基础 API |
| Model API | Model 服务 | 大模型路由,表现为「1 个 API + N 条匹配规则」,支持单后端、按模型名称、按比例三种后端策略与 Fallback 兜底。 | Model API |
| Agent API | Agent 服务 | Agent 路由,支持 HTTP 与 WebSocket 协议。 | Agent API |
请求协议
| 协议 | 适用场景 | 支持的 API 类型 |
|---|---|---|
| HTTP | 对接口没有统一规范约束的常规请求-响应场景,例如数据查询、表单提交、业务接口调用。 | 基础 API、Model API、Agent API |
| WebSocket | 实时双向通信场景,例如消息推送、在线聊天、AI、IoT。连接建立后,客户端与服务端可持续保持连接并互相发送消息。 | 基础 API、Agent API,以及服务协议为「自定义 WebSocket」的 Model API |
三类 API 的能力对比
| 能力 | 基础 API | Model API | Agent API |
|---|---|---|---|
| 请求协议可选 | HTTP / WebSocket | 由所属服务的服务协议决定 | HTTP / WebSocket |
| 路径匹配方式 | 精确 / 前缀 / 正则 | 自定义协议服务下可选精确 / 前缀 / 正则;标准协议服务使用预置路由 | 精确 / 前缀 / 正则 |
| Header / Query 匹配 | 支持 | 支持 | 支持 |
| 优先级 | 0-9999 | 0-9999 | 0-9999 |
| 后端策略 | 单服务实例 / 多服务实例(按权重) | 单后端 / 按模型名称 / 按比例 | 单 Agent 后端 |
| Fallback | 不涉及 | 支持 | 不涉及 |
| 匹配规则粒度管理 | 不涉及 | 支持(规则级发布/禁用/删除) | 不涉及 |
| 发布与下线粒度 | API 级别 | 匹配规则级别 | API 级别 |
| 高级策略 | 超时、URL 重写、重试 | 超时、URL 重写、重试(可由服务侧批量下发) | 超时、URL 重写、重试 |
| 消费者认证 | 支持 | 支持 | 支持 |
| AI 指标(Token 等) | 不涉及 | 支持 | 支持 |
前提条件
通用说明
以下能力三类 API 表现一致,各模块文档中均有说明:
- 匹配优先级:范围 0-9999,0 最高。优先级相同时按默认规则匹配——精确匹配 > 前缀匹配 > 正则匹配,路径段数多者优先,Header 匹配数量多者优先且 Header 优先于 Query,Query 匹配数量多者优先。
- 请求处理链路:API 详情页以图形化方式展示「API → 安全防护 → 策略与插件 → 后端」,策略与插件支持在链路图中局部修改。
- 消费者认证:API 侧开启后优先级高于所属服务,详见授权管理。
- 监控:实例维度在「观测与分析 > 业务监控」对应服务类型标签页查看,服务维度在服务详情的「监控」标签页查看,详见业务监控。
相关操作
基础 API
Model API
Agent API
其他
- 服务概述:了解 API 的归属单元。
评价此篇文章
