云函数触发器配置描述 - 开发指南

VIEW CONTENTS

摘要: 当您调用触发器接口设置函数触发方式（CreateTrigger）时，对应的TriggerDesc参数为触发器描述，您可参考本文进行使用。定时触发器该参数直接填写Cron表达式，相关内容请参考Cron表 ...

点击领取2000元阿里云代金券，付款抵现金用，云服务器69元/年限时抢>>>    点击咨询成为阿里云VIP客户享永久折扣>>>
点击领取2860元腾讯云代金券，付款抵现金用，云服务器88元/年限时抢>>>    点击成为腾讯云VIP客户享永久折扣优惠>>>
点击进入华为云最新优惠活动现场>>>    点击成为华为云VIP客户享永久折扣优惠>>>

当您调用触发器接口设置函数触发方式（CreateTrigger）时，对应的 TriggerDesc 参数为触发器描述，您可参考本文进行使用。

定时触发器

该参数直接填写 Cron 表达式，相关内容请参考 Cron 表达式。

TriggerDesc 示例

每五分种触发一次

0 */5 * * * * *

API 网关触发器

名称	类型	必选	描述
api	ApigwApi	否	创建 API 网关的 API 配置
service	ApigwService	否	创建 API 网关的 Service 配置
release	ApigwRelease	否	创建 API 网关后，发布的环境

ApigwApi

名称	类型	必选	描述
authRequired	String	否	是否需要鉴权，可选 TRUE 或者 FALSE，默认为 FALSE
requestConfig	ApigwApiRequestConfing	否	请求后端 API 的配置
isIntegratedResponse	String	否	是否使用集成响应，可选 TRUE 或者 FALSE，默认为 FALSE

ApigwApiRequestConfing

名称	类型	必选	描述
method	String	否	请求后端 API 的 method 配置，必须是 `ANY`、`GET`、`HEAD`、`POST`、`PUT`、`DELETE` 中的一种

ApigwService

名称	类型	必选	描述
serviceId	String	否	Apigw Service ID（不传入则新建一个 Service）

ApigwRelease

名称	类型	必选	描述
environmentName	String	是	发布的环境，填写 `release`、`test` 或 `prepub`，不填写默认为`release`

TriggerDesc 示例

{
"api":{
  "authRequired":"FALSE",
  "requestConfig":{
    "method":"ANY"
  },
  "isIntegratedResponse":"FALSE"
},
"service":{
  "serviceName":"SCF_API_SERVICE"
},
"release":{
  "environmentName":"release"
}
}

Ckafka 触发器

名称	类型	必选	描述
maxMsgNum	String	是	5秒内每汇聚 maxMsgNum 条 Ckafka 消息，则触发一次函数调用
offset	String	是	offset 为开始消费 Ckafka 消息的位置，目前支持 `latest`、`earliest` 和`毫秒级时间戳`三种方式
retry	String	是	当函数报错时最大重试次数

TriggerDesc 示例

{"maxMsgNum":100,"offset":"latest","retry":10000}

{"maxMsgNum":999,"offset":"1595927203000","retry":10}

API 请求说明

使用 API 请求创建 Ckafka 触发器时，TriggerName 字段需定义为要转储的 Ckafka instanceId，topicName 信息。
[instanceId]-[topicName]，请求示例如下：

TriggerName: "ckafka-8tfxzia3-test"

COS 触发器

名称	类型	必选	描述
event	String	是	COS 的事件类型
filter	CosFilter	是	COS 文件名的过滤规则

CosFilter

名称	类型	必选	描述
Prefix	String	否	过滤文件的前缀规则
Suffix	String	否	过滤文件的后缀规则，必须以`.`开头

COS 事件冲突规则

核心思想：一个事件最多触发一次函数调用。如果一个事件有其他产品绑定，该事件也不可再绑定至函数。
最多设置一个前缀过滤及一个后缀过滤。
若已设置 cos:ObjectCreated:* 事件，且没有设置前后缀，则后续再绑定任何以 cos:ObjectCreated 作为开头的事件都会失败。
前缀及后缀均匹配才有效，且当前缀和后缀都冲突的时候，后面的绑定会失败。

TriggerDesc 示例

{"event":"cos:ObjectCreated:*","filter":{"Prefix":"","Suffix":""}}

注意：

在 TriggerDesc 中作为触发器描述时，JSON 字符串须是连续且中间不能有空格的字符串。

API 请求说明

使用 API 请求创建 COS 触发器，TriggerName 字段需定义为要转储的 COS 存储桶 XML API 访问域名，示例如下：

TriggerName: "xxx.cos.ap-guangzhou.myqcloud.com"

注意：

访问域名请在对象存储控制台【存储桶列表】>【基础配置】>【基本信息】中查看。

CMQ 触发器

名称	类型	必选	描述
filterType	String	否	消息过滤类型，`1`为标签类型，`2`为路由匹配类型
filterKey	String	否	当 `filterType` 为`1`时表示消息过滤标签，当 `filterType` 为`2`时表示 Binding Key