概述
更新时间:2026-09-29
欢迎使用百度智能云产品——API 网关专享版(API Gateway)。
本文档是 API 网关专享版的 OpenAPI 参考。您可以通过本文档介绍的 API 对网关实例及其内部的服务、域名、API、后端、插件、消费者等资源进行灵活的操作。所有资源均在网关实例内管理,使用 OpenAPI 前请先创建实例。
API 网关专享版 OpenAPI 具有以下特性:
- 所有接口统一使用
POST /?action=Xxx的调用方式,请求体与响应体均为 JSON 格式;每个接口的 action 名称、请求参数与返回参数详见对应接口文档。 - 所有接口均需携带
Authorization头完成签名鉴权。
如果您是初次调用百度智能云产品的 API,可以观看API 入门视频指南,快速掌握调用 API 的能力。
API 网关专享版 API 提供下列接口类型:
| 接口类型 | 描述 |
|---|---|
| 实例接口 | 网关实例是 API 网关专享版的运行实体,独占资源并承载全部入站流量,服务、后端、API、消费者、插件等资源均在实例内管理。API 网关专享版 API 提供创建、查询、释放实例,开启 / 关闭公网与私网访问、指标监控、BLS 日志监控和 OTel 链路追踪,换绑公网 EIP,以及查询实例价格、套餐列表和监控指标等接口。 |
| 服务接口 | 服务是 API 的归属与组织单元,一个服务下可以包含多个 API,支持 HTTP 服务、Model 服务和 Agent 服务三种类型。API 网关专享版 API 提供创建、查询、删除服务,校验服务名称,查询 Model 服务预置路由模板和预览服务变更等接口。 |
| 后端接口 | 后端是网关代理的目标服务,即请求最终被转发到的真实服务,支持 AI 模型后端、域名后端、IP 后端和 Agent 后端四种类型。API 网关专享版 API 提供创建、编辑、查询、删除后端,以及查询后端类型等接口。 |
| API 接口 | API(路由)是服务下的一条访问路径,定义请求如何匹配(路径、方法、请求头、请求参数)并按设定的策略转发到一个或多个后端,支持 HTTP/WebSocket API、Model API 和 Agent API 三种类型。API 网关专享版 API 提供创建、编辑、发布、下线、删除 API,预览 API 变更、查询 Model 路由路径选项,以及创建、删除 Agent 后端和 API 等接口。 |
| 插件接口 | 插件是在不修改业务代码的情况下为网关流量增加治理能力的扩展机制,可按实例、域名、API 级别生效并支持热更新。API 网关专享版 API 提供查询插件列表与详情,创建、编辑自定义插件,安装插件到实例 / 域名 / API,启用或禁用、卸载插件,以及查询插件绑定详情等接口。 |
| 消费者接口 | 消费者是调用网关 API 的客户端身份或应用实体,用于权限控制、配额管控、流量追踪和费用统计。API 网关专享版 API 提供创建、查询、删除消费者,创建与重置 API Key 或 AK/SK 凭证,开启或关闭消费者认证与配额,创建、编辑消费者授权和绑定关系,以及查询消费者用量汇总等接口。 |
| 域名接口 | 自定义域名是网关对外提供服务的访问入口,绑定到服务后客户端即可通过该域名访问服务下的 API,并支持绑定 SSL 证书实现 HTTPS 安全访问。API 网关专享版 API 提供创建、查询、删除域名,以及绑定、解绑服务域名等接口。 |
调用 API 前,请先获取目标地域的服务域名,详见服务域名。接口中涉及的公共数据结构(请求与响应模型、枚举取值等)统一收录在附录中。
评价此篇文章
