参数 | 说明 |
应用名称 | 输入应用的名称,建议使用有业务含义的命名,例如"智能客服应用"。 |
认证类型 | APIKey:应用密钥,用于标识和验证应用的身份,确保 API 调用的安全性。 SecretKey:增强认证安全性,生成令牌或签名。 免认证:纯代理模式,关联的模型 API 和 MCP 资源无需凭据即可访问。 登录:即 OAuth2 认证,实现授权码流、客户端凭据等标准流程。需在已创建的 API 认证 和 MCP 认证中分别进行选择,可多选。 每种认证类型最多支持创建 10 条凭据数据;免认证类型无凭据,无需生成密钥。 |
描述 | 输入对该应用的描述信息,便于后续管理和识别。 |
参数名称 | 参数说明 |
API 名称 | 自定义 API 的名称,用于标识和区分不同的 API。由64字符以内的中文、大小写字母、数字、下划线(_)、短横线(-)、英文括号(())或中文括号(())组成,在同一实例下必须唯一。 |
后端服务类型 | Restful:后端为标准的 HTTP/HTTPS 接口服务,需填写后端地址等信息。 数据库:后端直连数据库,需填写数据库类型、连接地址、账号密码等信息。 Mock:无需真实后端,由网关直接返回模拟响应,需填写响应码、响应头和响应体。 |
API 描述 | 填写该 API 的主要功能与使用场景说明。该描述信息会在调用时被传递给大模型,帮助大模型更好地理解 API 的用途。支持中文、英文、数字及常用字符,长度不超过1024个字符。 |
参数名称 | 参数说明 |
请求域名 | API 对外暴露的访问域名,由网关自动分配或用户自定义绑定,例如 api.example.com。客户端通过该域名访问 API。 |
请求路径 | 匹配方式: 前缀匹配:请求路径前缀一致即可匹配,支持子路径透传。 完全匹配:请求路径必须与配置值完全一致才能匹配。 正则匹配:请求路径满足配置的正则表达式即可匹配。 访问路径:API 的对外请求路径,以 /进行分割,例如/ebus/amp/rio/web。客户端请求时将匹配该路径进行转发。 |
请求方法 | 限制客户端调用 API 时使用的 HTTP 请求方法,支持 ANY(不限制)、GET、POST、PUT、DELETE、HEAD,默认 ANY。 |
请求头信息 | 启用后可根据请求头(Header)内容匹配请求,仅匹配的请求才会被转发到后端。适用于根据 User-Agent、Content-Type 等 Header 做路由区分的场景。 |
请求参数信息 | 启用后可根据请求参数(Query 或 Body 参数)内容匹配请求,仅匹配的请求才会被转发。适用于根据业务参数做路由区分的场景。 |
入参信息 | 启用后可对客户端传入的参数进行校验(如类型、格式、取值范围等),校验不通过时直接返回错误,不再转发到后端。 |
出参信息 | 启用后可对后端返回的参数进行校验,校验不通过时可触发拦截或告警,适用于保证返回数据合规性的场景。 |
参数名称 | 参数说明 |
后端服务配置 | 选择后端服务的来源方式: 自定义后端服务:手动填写后端地址。 后端服务组:选择已创建的后端服务组,便于统一管理多个后端节点。 |
后端配置类型 | 后端服务配置为自定义后端服务时,选择后端地址的填写方式: 域名/IP:直接填写后端服务器的域名或 IP 地址。 VPC:填写 VPC 内的服务地址,适用于后端服务部署在私有网络中的场景。 |
后端服务 | 后端服务类型为域名/IP 时填写后端服务的访问地址,格式为 {domain}:{port},例如api.example.com:8080。支持添加多条后端地址,并分别为每条地址配置转发权重(权重之和为100)。说明: 请注意域名/IP 为空时,请求该服务时无法转发到对应的服务 |
IP | 后端服务类型为 VPC 时填写后端服务的访问地址,格式为 {ip}:{port},例如10.0.1.10:8080。支持添加多条后端地址,并分别为每条地址配置转发权重(权重之和为100)。说明: 请注意 IP 为空时,请求该服务时无法转发到对应的服务 |
后端服务组 | |
负载方式 | 当配置了多个后端服务时,选择请求分发策略: 随机负载:使用网关集群,采用随机负载方案,每个请求落在随机的服务器。 会话保持:使用网关集群,采用一致性负载方案,同一个会话的请求会被转发到同一台服务器。 轮询:单工作进程内每个请求分配给服务器列表中的下一个服务器。 |
协议类型 | 网关与后端服务之间通信使用的协议,例如 http 或 https。 |
协议版本 | 网关与后端服务通信时使用的协议版本,例如 1.1(表示 HTTP/1.1)。 |
请求 host 类型 | 设置转发到后端的请求中 host 头的值: 修正为源站 host:使用后端服务地址中的 host。 保持原请求 host:保留客户端原始请求的 host。 自定义 host:手动指定要发送的 Host 值。 |
自定义 host | 请求 host 类型为自定义 host 时,手动指定要发送的 host 值。 |
后端路径 | 转发到后端的请求路径,支持256字符以内的非特殊字符。 |
超时时间 | 网关等待后端服务响应的最大时长,单位秒,最多60秒。超过该时间后端未响应,网关将返回超时错误。 |
version | 按 API 版本号进行路由转发,配置版本值(如 v1)与对应后端转发路径的映射关系。支持添加多条,不同版本的请求将转发到不同的后端路径。适用于版本灰度或多版本并存场景。 |
参数名称 | 参数说明 |
数据源 | |
配置方式 | 选择数据库操作的配置方式: 脚本方式:直接编写 SQL 语句,灵活度高,适用于复杂查询或自定义 SQL 场景。 向导方式:通过可视化向导选择表和字段,无需编写 SQL,适用于简单查询场景。 |
SQL 语句 | 配置方式为 SQL 语句时,填写要执行的 SQL 语句。支持通过参数占位符(如 ${param})注入请求中的变量值,实现动态 SQL 查询。SQL 语句将在网关收到请求后,由网关代理执行并返回查询结果。 |
参数名称 | 参数说明 |
响应码 | 选择 Mock 响应的 HTTP 状态码,例如 200 OK。下拉选择常用状态码,表示网关直接返回给客户端的 HTTP 响应状态。 |
响应头 | 自定义 Mock 响应的 HTTP 响应头(Header)。以键值对形式添加,可配置多个字段名与对应值,例如 Content-Type: application/json。客户端将收到这些自定义响应头。 |
响应体 | 填写 Mock 返回的响应内容体(Body)。支持通过变量占位符注入请求中的动态参数值,实现带变量的 Mock 响应: ${query.a}:注入 URL 查询参数中名为 a 的值。${headers.x}:注入请求头中名为 x 的值。${body.b}:注入请求体中名为 b 的字段值。适用于需要根据入参动态构造响应内容的联调和测试场景。 |
参数名称 | 参数说明 |
流量控制 | 开启后可自定义某个时间内最大请求次数、时间窗口长度、转发超时时间等。提供四种控制方法: 令牌桶:从固定容量的桶中取令牌,取不到的则触发限流。调整令牌桶容量可以限制请求的数量;调整令牌生成速率可以限制请求的速率。 漏斗:向固定容量的漏斗中加水,水溢出则触发限流。调整漏斗容量可以限制请求的数量;调整漏斗流速可以限制请求的速率。 滑动窗口:长度固定窗口向前滑动,请求固定进来占据位置,满则触发限流。调整窗口内最大请求次数可以限制请求的数量;调整窗口长度可以限制请求的速率。 时间窗口:调整时间窗口内最大请求次数可以限制请求的数量;调整时间长度可以限制请求的速率。 |
健康检查 | 开启后可定期对 API 的健康情况进行检查: 健康检查路径:网关定期访问的目标路径,后端需在此路径提供健康检查接口。 健康检查超时:等待响应的最大时长,最多60秒。 健康检查码:判定健康的 HTTP 状态码列表,如200,支持添加多个。 |
格式转换 | 开启后可对 API 的请求格式和响应格式进行转换: 请求资源类型:客户端请求的源数据格式。 请求目标类型:转发到后端的目标数据格式。 返回资源类型:后端返回的源数据格式。 返回目标类型:返回给客户端的目标数据格式。 |
IP 黑名单 | 开启后可限定指定的 IP 无法访问该模型 API,其他 IP 都可访问。单击 + 添加逐条录入 IP 地址。 |
IP 白名单 | 开启后只允许指定的 IP 访问该模型 API,其他 IP 都无法访问。单击 + 添加逐条录入 IP 地址。 |
限制特定用户访问 API | 限制特定用户访问 API: 所用插件:下拉选择已安装的插件,如限制特定用户访问 API。 插件设置名称:自定义配置名称,便于识别和区分。 插件设置说明:填写用途或业务背景说明。 优先级:数值越小优先级越高,默认1,多插件时按优先级顺序执行。 用户列表:用户 ID 列表,英文分号分隔,如 userid1;userid2。token:插件校验所需的 token。 |
参数名称 | 参数说明 |
API 名称 | 下拉选择已创建的 API,支持按名称搜索。 |
是否鉴权 | 选择是否对此 API 启用鉴权: 是:需要选择凭据进行身份验证,客户端调用时必须携带对应凭据信息。 否:无需鉴权即可访问。 |
选择凭据 | 当是否鉴权选择是时,下拉选择已创建的凭据,用于 API 调用的身份验证。 |
流量控制 | 开启后可自定义某个时间内最大请求次数、时间窗口长度、转发超时时间等。提供四种控制方法: 令牌桶:从固定容量的桶中取令牌,取不到的则触发限流。调整令牌桶容量可以限制请求的数量;调整令牌生成速率可以限制请求的速率。 漏斗:向固定容量的漏斗中加水,水溢出则触发限流。调整漏斗容量可以限制请求的数量;调整漏斗流速可以限制请求的速率。 滑动窗口:长度固定窗口向前滑动,请求固定进来占据位置,满则触发限流。调整窗口内最大请求次数可以限制请求的数量;调整窗口长度可以限制请求的速率。 时间窗口:调整时间窗口内最大请求次数可以限制请求的数量;调整时间长度可以限制请求的速率。 |
$ curl -X GET https://<网关域名>/<API路径> \\-H "<SECRET_ID>: <你的SecretId>" \\-H "<SECRET_KEY>: <你的SecretKey>"
$ curl -X GET https://<网关域名>/<API路径>
参数 | 说明 |
网关域名 | AI Agent 安全网关分配的访问域名。 |
API 路径 | API 中配置的前端请求路径,请替换为实际值。 |
SecretId / SecretKey | 应用的凭据信息,填写创建应用时生成的默认凭据。 |
文档反馈