函数计算提供了丰富类型的触发器,不同种类的触发器事件格式会根据具体情况而有所差异,下面将详细列举各触发器对应的事件格式。
说明
本文提及的”事件格式“指事件函数中,接收到的event变量的数据结构。
HTTP触发器
通过HTTP触发器和自定义域名访问事件函数时,仅会把请求中的body部分通过event传递到事件函数的handler,数据类型是byte数组。而header和queryparams等其余请求信息会被丢弃,如果用户需要关心请求中除body以外的信息,可以使用Http函数
说明
”事件函数“指的是标准运行时下,处理程序类型为”处理事件请求“的函数。
”HTTP函数“指的是标准运行时下,处理程序类型为”处理 HTTP 请求“的函数。
云原生网关触发器
云原生网关触发器与Http触发器的行为相同,详细请参考上文。
定时触发器
{
"time": "2024-12-05T02:24:09Z",
"name": "trigger-name",
"data": "hello,trigger"
}
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
time | string | 2024-12-05T02:24:09Z | 消息被触发的时间。 |
name | string | trigger-name | 触发器的名称。 |
data | string | hello,trigger | 定时触发器配置中用户填写的”触发消息“内容。 |
Kafka触发器
有两种消息格式:RawData和CloudEvent格式,可在触发器配置里选择。
CloudEvent格式如下:
[
{
"id": "eca53463-6baf-4d56-8f86-cbdb748208ed",
"source": "ctyun.faas.trigger.kafka",
"specversion": "1.0",
"type": "kafka:topic:send-message",
"datacontenttype": "application/json",
"subject": "kafka-trigger-mqbjvsezbp-dial-test:test-for-faas",
"time": "2025-05-22T02:04:16Z",
"data": {
"headers": {},
"timestamp": 1747879456,
"topic": "test-for-faas",
"partition": 0,
"offset": 15280,
"key": "",
"value": "msg[9]: 154b2a0e-2c3d-4b03-ae9e-c225b5370c3b, ts=2025-05-22 02:04:16"
}
}
]
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
id | string | eca53463-6baf-4d56-8f86-cbdb748208ed | 事件ID。标识事件的唯一值。 |
source | string | ctyun.faas.trigger.kafka | 事件源。Kafka触发器固定为ctyun.faas.trigger.kafka。 |
specversion | string | 1.0 | CloudEvents协议版本。 |
type | string | kafka:topic:send-message | 事件类型。 |
datacontenttype | string | application/json | 参数data的内容形式。 |
subject | string | kafka-trigger-mqbjvsezbp-dial-test:test-for-faas | 事件主体。格式为[SourceName]:[消息topic]。 |
time | string | 2025-05-22T02:04:16Z | 消息被触发的时间。 |
data | object | - | Kafka触发器独有消息格式,详细参见下文RawData描述。 |
RawData格式是CloudEvent格式的子集,只包含原始kafka消息的信息,消息结构相当于CloudEvent的data字段
[
{
"offset" : 15280,
"partition" : 0,
"headers" : {},
"topic" : "test-for-faas",
"key" : "testkey",
"timestamp" : 1747879456,
"value" : "msg[9]: 154b2a0e-2c3d-4b03-ae9e-c225b5370c3b, ts=2025-05-22 02:04:16"
}
]
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
offset | int | 15280 | 消息偏移量。 |
partition | int | 0 | 分区信息。 |
headers | map | - | 消息携带的header。 |
topic | string | test-for-faas | topic的名称。 |
key | string | testkey | 消息的key。 |
timestamp | int | 1747879456 | Unix时间戳(秒)。 |
value | string | hello,kafka | 消息的内容。 |
RocketMQ触发器
有两种消息格式:RawData和CloudEvent格式,可在触发器配置里选择。
CloudEvent格式如下:
[
{
"id": "21000777109E05EF04B574B8A1DF0001",
"source": "ctyun.faas.trigger.rocketmq",
"specversion": "1.0",
"type": "rocketmq:topic:send-message",
"datacontenttype": "application/json",
"subject": ":mq-func-hckzeddbxj-rocket-test:test-for-faas",
"time": "57361-07-03T16:18:39Z",
"data": {
"topic": "test-for-faas",
"properties": {
"CLUSTER": "1dafcb4049ba42df96d80b7dd2f99c5e",
"CONSUME_START_TIME": "1747987057130",
"KEYS": "webtest",
"MAX_OFFSET": "2",
"MIN_OFFSET": "0",
"TAGS": "1747987057097_0",
"UNIQ_KEY": "21000777109E05EF04B574B8A1DF0001"
},
"data": "WebTestTools_174798gjkS"
}
}
]
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
id | string | 21000777109E05EF04B574B8A1DF0001 | 事件ID。标识事件的唯一值。提取自RocketMQ消息。 |
source | string | ctyun.faas.trigger.rocketmq | 事件源。RocketMQ触发器固定为ctyun.faas.trigger.rocketmq。 |
specversion | string | 1.0 | CloudEvents协议版本。 |
type | string | rocketmq:topic:send-message | 事件类型。 |
datacontenttype | string | application/json | 参数data的内容形式。 |
subject | string | mq-func-hckzeddbxj-rocket-test:test-for-faas | 事件主体。 |
time | string | 2025-05-22T02:04:16Z | 消息被触发的时间。 |
data | object | - | RocketMQ触发器独有消息格式,详细参见下文RawData描述。 |
RawData格式是CloudEvent格式的子集,只包含原始rocketmq消息的信息,消息结构相当于CloudEvent的data字段,具体如下:
[
{
"topic": "test-for-faas",
"properties": {
"CLUSTER": "1dafcb4049ba42df96d80b7dd2f99c5e",
"CONSUME_START_TIME": "1747987204637",
"KEYS": "webtest",
"MAX_OFFSET": "3",
"MIN_OFFSET": "0",
"TAGS": "1747987204605_0",
"UNIQ_KEY": "2100077510A605EF04B574BAE2080001"
},
"data": "WebTestTools_17v6fg0J"
}
]
参数 | 类型 | 示例 | 描述 |
---|---|---|---|
topic | string | test-for-faas | Topic名称。 |
properties | map | - | 消息自定义属性。 |
properties.CLUSTER | string | 1dafcb4049ba42df96d80b7dd2f99c5e | RocketMQ实例ID。 |
properties.CONSUME_START_TIME | string | 1747987204637 | Unix时间戳,毫秒。 |
properties.KEYS | string | webtest | 消息的key。 |
properties.MAX_OFFSET | string | 3 | 消息队列中的最大偏移量。 |
properties.MIN_OFFSET | string | 0 | 消息队列中的最小偏移量。 |
properties.TAGS | string | 1747987204605_0 | 消息标签。 |
properties.UNIQ_KEY | string | 2100077510A605EF04B574BAE2080001 | 消息唯一键。 |
data | string | WebTestTools_17v6fg0J | 消息体内容。 |
RabbitMQ触发器
有两种消息格式:RawData和CloudEvent格式,可在触发器配置里选择。
CloudEvent格式如下:
[
{
"id": "eca53463-6baf-4d56-8f86-cbdb748208ed",
"source": "ctyun.faas.trigger.rabbitmq",
"specversion": "1.0",
"type": "rabbitmq:queue:send-message",
"datacontenttype": "application/json",
"subject": ":mq-func-hckzeddbxj-rabbit::test-for-faas",
"time": "2025-05-22T02:04:16Z",
"data": {
"headers": {
"myheader": "header-value"
},
"properties": {
"deliveryMode": 1,
"priority": 0
},
"deliveryTag": 1,
"redelivered": false,
"exchange": "",
"routingKey": "test-for-faas",
"body": "hello, rabbitmq"
}
}
]
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
id | string | eca53463-6baf-4d56-8f86-cbdb748208ed | 事件ID。标识事件的唯一值。 |
source | string | ctyun.faas.trigger.rabbitmq | 事件源。RabbitMQ触发器固定为ctyun.faas.trigger.rabbitmq。 |
specversion | string | 1.0 | CloudEvents协议版本。 |
type | string | rabbitmq:queue:send-message | 事件类型。 |
datacontenttype | string | application/json | 参数data的内容形式。 |
subject | string | mq-func-hckzeddbxj-rabbit::test-for-faas | 事件主体。 |
time | string | 2025-05-22T02:04:16Z | 消息被触发的时间。 |
data | object | - | RabbitMQ触发器独有数据格式,详细参见下文RawData描述。 |
RawData格式是CloudEvent格式的子集,只包含原始rabbitmq消息的信息,消息结构相当于CloudEvent的data字段,具体如下:
[
{
"headers": {
"myheader": "100"
},
"properties": {
"deliveryMode": 1,
"priority": 0,
"type": "mytype"
},
"deliveryTag": 1,
"redelivered": false,
"exchange": "",
"routingKey": "test-for-faas",
"body": "hello, rabbitmq"
}
]
参数 | 类型 | 示例 | 描述 |
---|---|---|---|
headers | map | {"myheader": "100"} | 消息的自定义header。 |
properites | map | { | 消息的自定义属性值。 |
deliveryTag | int | 1 | 消息的tag。 |
redelivered | bool | false | 消息是否是被重新投递: false:表示这条消息是第一次投递给消费者。 true:表示这条消息是被重新投递的。 |
exchange | string | - | 消息的Exchange。 |
routingKey | string | test-for-faas | 消息的路由key。 |
body | string | hello, rabbitmq | 消息的内容。 |
MQTT触发器
[
{
"messageId" : 0,
"payload" : "Hello, MQTT",
"topic" : "test-for-faas"
}
]
参数 | 类型 | 示例 | 描述 |
---|---|---|---|
messageId | int | 0 | 消息的id。 |
payload | string | Hello, MQTT | 消息的内容。 |
topic | string | test-for-faas | 消息topic名称。 |
对象存储触发器
{
"id": "1723530386.250878.3f7f5c***",
"source": "ctyun.zos",
"specversion": "1.0",
"type": "s3:ObjectCreated:Post",
"subject": "ctyun.zos:b342b77ef26b11e***:5d4ce56a08db4a***:bucket-***:abc.txt",
"time": "2024-03-05T13:52:18.374Z",
"data": {
"userIdentity": {
"principalId": "testuser_sub1"
},
"responseElements": {
"x-amz-request-id": "ec2906f5-e72t-494f-9aa1-f621108***",
"x-amz-id-2": "1286b9-zone2-zon***"
},
"s3": {
"bucket": {
"name": "bucket-***",
"ownerIdentity": {
"principalId": "testuser"
},
"arn": "arn:aws:s3:::bucket-***",
"id": "ec2906f5-e72f-494f-9aa1-f6211***"
},
"object": {
"key": "abc.txt",
"size": 417791,
"etag": "3f7f 5c925b10c789e3e1389***",
"versionId": "",
"sequencer": "92FCBA66FA6***",
"metadata": []
}
}
},
"datacontenttype": "application/json;charset=utf-8",
"ctyunaccountid": "5d4ce56a08db4ac19***",
"ctyunuserid": "usertest-userid",
"ctyunresourceid": "",
"ctyuneventbusname": "default",
"ctyunregion": "b342b77ef26b11ecb0***"
}
参数 | 类型 | 示例 | 描述 |
---|---|---|---|
id | string | 1723530386.250878.3f7f5c*** | 事件ID。标识事件的唯一值。 |
source | string | ctyun.zos | 事件源。对象存储触发器固定为ctyun.zos。 |
specversion | string | 1.0 | CloudEvents协议版本。 |
type | string | s3:ObjectCreated:Post | 事件类型。 |
subject | string | ctyun.zos:b342b77ef26***:5d4ce56a08d***:bucketname***:objectname*** | 事件主体。格式为ctyun.zos::::,其中是资源池ID,是天翼云账号ID,是对象存储产生事件的bucket名称,是对象存储产生事件的文件名称。 |
time | string | 2024-03-05T13:52:18.374Z | 事件产生的时间。 |
datacontenttype | string | application/json;charset=utf-8 | 参数data的内容形式。 |
data | object | - | 事件内容。JSON对象,内容由发起事件的服务决定。CloudEvents可能包含事件发生时由事件生产者给定的上下文,data中封装了这些信息。 |
ctyunaccountid | string | 5d4ce56a08db4ac19*** | 天翼云账号ID |
ctyunuserid | string | usertest-userid | 天翼云用户ID |
ctyunresourceid | string | 27aadda4-db94-11ee-a6fc-e8b47009**** | 天翼云资源ID |
ctyuneventbusname | string | default | 接收事件的事件总线名称,天翼云产品事件为default。 |
ctyunregion | string | b342b77ef26b11ecb0*** | 接收事件的地域。 |
日志触发器
{
"id": "dc4b3a28-3688-400e-8a69-a647bafb015b",
"type": "ctlts:unit-insert",
"source": "ctyun.ctlts",
"subject": "392b21xxe79477",
"specversion": "1.0",
"time": "2024-12-05T08:51:22.663089039Z",
"data": {
"beginCursor": 381681168434049700,
"endCursor": 381681168434051100,
"unitCode": "392b21xxe79477"
},
"ctyuneventbusname": "default",
"ctyunaccountid": "5d4ce56a08xxxx995b6c3c92ac5884",
"ctyunregion": "b342b77ef2xxxxecb0ac0242ac110002"
}
参数 | 类型 | 示例 | 描述 |
---|---|---|---|
id | string | dc4b3a28-3688-400e-8a69-a647bafb015b | 事件ID。标识事件的唯一值。 |
source | string | ctyun.ctlts | 事件源。日志触发器固定为ctyun.ctlts。 |
specversion | string | 1.0 | CloudEvents协议版本。 |
type | string | ctlts:unit-insert | 事件类型。 |
subject | string | 392b21xxe79477 | 事件主体。这里是日志单元ID。 |
time | string | 2024-03-05T13:52:18.374Z | 事件产生的时间。 |
data | object | - | 事件内容。JSON对象,内容由发起事件的服务决定。CloudEvents可能包含事件发生时由事件生产者给定的上下文,data中封装了这些信息。 |
data.beginCurror | int | 381681168434049700 | 日志数据起始游标,标识增量日志的开始位置 |
data.endCursor | int | 381681168434051100 | 日志数据结束游标,标识当次上报日志结束为止 |
data.unitCode | string | 392b21xxe79477 | 日志单元ID |
ctyunaccountid | string | 5d4ce56a08db4ac19*** | 天翼云账号ID |
ctyuneventbusname | string | default | 接收事件的事件总线名称,天翼云产品事件为default。 |
ctyunregion | string | b342b77ef26b11ecb0*** | 接收事件的地域。 |