You need to enable JavaScript to run this app.
导航

创建 API 网关触发器

最近更新时间2023.06.27 14:22:51

首次发布时间2022.06.16 21:30:25

函数服务支持使用火山引擎的 API 网关 作为事件源,通过公网或私网 HTTP/HTTPS 流量触发函数逻辑,对外提供函数的业务能力。本文为您介绍如何创建 API 网关触发器。

说明

API 网关当前处于公测状态,如需体验,请提交 公测申请

背景信息

API 网关触发器为双向集成触发器:分别支持在函数服务控制台和 API 网关控制台进行配置。对应关系如下:
函数服务侧的 API 网关触发器,对应 API 网关侧的一个函数类型 Upstream 和一组指向当前 Upstream 的路由。

前提条件

使用限制

  • 每个函数最多支持创建 20 个触发器。
  • 函数服务侧,在同一个网关实例下,一个函数仅支持创建一个 API 网关触发器;且 API 网关触发器仅支持绑定一条 100% 权重的路由。
  • API 网关触发器创建成功后,不支持变更所属网关实例和网关服务,不支持修改触发器名称和路由名称。
  • 每个 API 网关触发器,最多支持展示 5 个网关服务和 200 条路由。超出后需前往 API 网关控制台查看。
  • 删除函数前,需要先删除所有 API 网关触发器。
  • 操作入口推荐
    • 如果您只需要一条 100% 指向目标函数的路由,推荐在函数服务侧创建 API 网关触发器。此情形下,函数服务侧支持创建/编辑/删除操作。
    • 如果您有更多需求,例如:一条路由对接多个函数达到多版本/多环境管理需求,或者多条路由对接一个函数等,请前往 API 网关控制台 进行操作。具体可参考 创建函数服务类型 Upstream创建路由。此情形下,函数服务侧仅支持查看已绑定路由信息,不支持创建/编辑/删除操作。

操作步骤

  1. 登录 函数服务控制台

  2. 在顶部导航栏,选择目标地域。

  3. 在 函数列表 页面,找到需要创建触发器的函数,单击函数名称。

  4. 在函数详情页面的 触发器 页签下,单击 创建触发器

  5. 创建触发器 面板,按要求设置参数。alt

    • 基本配置
    配置项说明
    触发器类型本场景选择 API 网关触发器。
    触发器名称自定义触发器名称。同一函数下,触发器名称不可重复。触发器名称创建成功后不支持修改。
    网关实例选择触发器所属的网关实例。
    网关服务进一步选择触发器所属的网关服务。
    • 网关路由
      为当前 API 网关触发器绑定一条 100% 权重的路由。
    配置项说明
    路由名称自定义路由名称。路由名称创建成功后不支持修改。
    Path设置允许访问函数的请求路径。仅支持前缀匹配,路径必须以/开头。
    权重显示当前路由的流量权重。函数服务侧仅支持配置 100% 权重的路由。
    请求方法选择允许访问函数的请求方法。支持 6 种请求方法:POST、GET、PUT、DELETE、HEAD、OPTIONS,请根据需要选择。

    超时

    API 网关触发器将请求转发给函数后,等待函数响应请求的时间上限。开启开关后,需设置具体的超时时间。请根据实际需要选择是否开启。

    • 开启超时开关,可单独控制 API 网关触发器的请求超时时间。如果您在函数服务侧同时设置了当前函数的超时时间,则实际生效的为更小的超时时间。
    • 关闭超时开关,则 API 网关触发器无超时时间限制。
    跨域开关通过在响应头中增加 Access-Control-Allow-Origin: * 实现跨域访问。如果您的函数允许跨域访问,请开启跨域开关,保证跨域数据的安全传输。
  6. 单击 确定,完成 API 网关触发器的创建。

后续操作