触发器类型说明
对于 Web 函数,触发器支持默认创建与自定义创建两种创建方式,您可以根据实际情况,选择合适的创建方案:
功能 | 默认创建(基础型网关:共享型实例) | 自定义创建(标准型网关:共享型实例&专享型实例) |
提供默认域名 | 支持 | 支持 |
自定义域名绑定 | 手动绑定 | API 网关控制台管理 |
请求方法配置 | 支持 | 支持 |
发布环境配置 | 支持 | 支持 |
鉴权方法配置 | 支持 | 支持 |
API 网关控制台可见 | 不可见 | 可见 |
API 网关高阶能力(插件/独占实例等) | 不支持 | 支持 |
计费方式 | 网关调用次数不计费 | 按照 API 网关标准计费方案计费 |
类型转换 | 可升级为标准型 API 网关,升级后可使用网关全部能力,按照 API 网关标准计费方案计费。 | 不可转换,标准型网关无法回退为默认创建的基础型网关。 |
触发器介绍
HTTP 类型 API 网关触发器具有以下特点:
透传 HTTP 请求
API 网关在接受到 HTTP 请求后,如果 API 在网关上的后端配置了对接云函数,该函数将会被触发运行,此时 API 网关会将 HTTP 请求直接透转,不再做 event 类型格式转换。HTTP 请求的相关信息包含了例如具体接受到请求的服务和 API 规则、请求的实际路径、方法、请求的 path、header、query 等内容。
同步调用
API 网关以同步调用的方式来调用函数,会在 API 网关中配置的超时时间未到前等待函数返回。调用类型详情请参见 调用类型。
触发器配置
基础型网关只能通过云函数控制台以默认创建的方式绑定。
API 网关触发器分别支持在 云函数控制台 或在 API网关控制台 中进行配置。触发器配置详情可参见 API 网关触发器配置。
触发器绑定限制
API 网关中,一条 API 规则仅能绑定一个云函数,但一个云函数可以被多个 API 规则绑定为后端。您可以在 API 网关控制台 创建一个包含不同路径的 API 并将后端指向同一个函数。相同路径、相同请求方法及不同发布环境的 API 被视为同一个 API,无法重复绑定。
请求与响应
针对 API 网关发送到云函数的请求处理方式,和云函数响应给 API 网关的返回值处理方式,称为请求方法和响应方法。Web 函数下,API 网关会在 header 里加上函数触发所需要的信息,并将原始请求直接透传,触发后端函数运行。
注意
以下参数不支持用户自定义配置:
connection 字段
以 X-SCF- 开头的自定义字段