tencent cloud

云函数

动态与公告
产品动态
产品公告
新手指引
产品简介
产品概述
相关概念
工作原理
产品优势
应用场景
相关产品
购买指南
计费概述
计费方式
计费项与计费方式
函数算力支持
免费额度
产品定价
计费示例
欠费与停服说明
快速入门
使用控制台创建一个事件函数
操作指南
配额管理
函数管理
Web 函数管理
日志管理
并发管理
触发器管理
函数 URL
自定义域名
版本管理
别名管理
权限管理
运行实例管理
插件管理
监控与告警管理
网络配置
层管理
执行配置
扩展存储管理
DNS 缓存配置
资源托管模式管理
近离线资源托管模式
工作流
触发器
触发器概述
触发器事件消息结构汇总
API 网关触发器
COS 触发器
CLS 触发器
定时触发器
CKafka 触发器
Apache Kafka 触发器
MQTT 触发器
触发器配置描述
MPS 触发器
CLB 触发器说明
云 API 触发器
开发指南
基本概念
测试云函数
环境变量
依赖安装
使用容器镜像
使用 Docker 安装依赖
错误类型与重试策略
死信队列
云函数接入数据库
自动化部署
云函数状态码
常见错误码解决方法
开发者工具
Serverless Web IDE
函数间调用 SDK
第三方工具
代码开发
Python
Node.js
Golang
PHP
Java
Custom Runtime
使用镜像部署函数
Web 框架部署
通过命令行完成框架部署
快速部署 Egg 框架
快速部署 Express 框架
快速部署 Flask 框架
快速部署 Koa 框架
快速部署 Laravel 框架
快速部署 Nestjs 框架
快速部署 Nextjs 框架
快速部署 Nuxtjs 框架
快速部署 Django 框架
实践教程
最佳实践概述
云产品联合解决方案
业务开发相关实践
实时音视频 TRTC
对象存储 COS
消息队列 CKafka
日志服务CLS
负载均衡 CLB
视频处理 MPS
内容分发网络 CDN
云数据仓库 PostgreSQL
云点播 VOD
短信 SMS
Elasticsearch Service
定时任务
视频处理
客户案例
腾讯在线教育
在线教育行业案例
游戏聊天系统
腾讯互娱国际（IEGG）
API 文档
History
Introduction
API Category
Making API Requests
Other APIs
Namespace APIs
Layer Management APIs
Async Event Management APIs
Trigger APIs
Function APIs
函数和层的状态说明
Data Types
Error Codes
SDK文档
常见问题
通用问题
Web 函数相关问题
计费相关问题
网络相关问题
日志相关问题
SCF 工具相关问题
事件处理相关问题
API 网关触发器相关问题
相关协议
Service Level Agreement
联系我们
词汇表
文档云函数触发器触发器配置描述

触发器配置描述

PDF
聚焦模式
字号
最后更新时间： 2024-04-19 16:44:05
当您调用触发器接口 设置函数触发方式（CreateTrigger）时，对应的 TriggerDesc 参数为触发器描述，您可参考本文进行使用。

定时触发器

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

TriggerDesc 示例

每五分种触发一次
0 */5 * * * * *

API 网关触发器

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

ApigwApi

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

ApigwApiRequestConfig

名称
类型
必选
描述
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
是
filter
是
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

TriggerDesc 示例

{"filterType":1,"filterKey":["test"]}
{"filterType":2,"filterKey":["#test"]}

API 请求说明

使用 API 请求创建 CMQ 触发器，TriggerName 字段需定义为 CMQ Topic，示例如下：
TriggerName: "Tabortest"

上一篇: MQTT 触发器下一篇: MPS 触发器

帮助和支持

本页内容是否解决了您的问题？

填写满意度调查问卷，共创更好文档体验。

文档反馈