Triggers pass message data in JSON format as the event input parameter to your function. This triggers function execution. The message data structure varies based on different triggers. This topic describes the event message structures for all triggers that are integrated with veFaaS.

Timer trigger

The structure of the Timer trigger event message is as follows:

Parameter	Type	Description
id	string	cloudevent field: request id. Each request has a unique id.
source	string	cloudevent field: For Timer triggers, the value is /faas/event/timer/{timer_id}.
specversion	string	cloudevent field: cloudevent version.
time	string	The time when the message is triggered, which is in the ISO 8601 format.
type	string	cloudevent field: the event type. For Timer triggers, the value is faas.timer.event.
datacontenttype	string	cloudevent field: message type. The value is always application/octet-stream.
data	string	The message content.

APIG trigger

The structure of the APIG trigger event message is as follows:

Parameter	Description
httpMethod	The HTTP request method, including POST, GET, PUT, DELETE, HEAD, and OPTIONS.
path	The HTTP request path.
pathParameters	The parameters of the HTTP request path.
queryStringParameters	The query parameters of the HTTP request path.
headers	The HTTP request header. For the descriptions of sub-parameters, see the following headers parameter descriptions.
body	The HTTP request payload.

The headers parameters are described as follows:

Parameter	Description
Host	The address of the function instance, which is in the format of instance IP:port.
User-Agent	The browser identifier string.
Accept	The file types acceptable to the browser.
Accept-Encoding	The encoding methods acceptable to the browser.
X-Faas-Request-Id	The unique identifier of the function request.

For Kafka triggers

The structure of the Kafka trigger event message is as follows:

Parameter	Type	Description
id	string	cloudevent field: request id. Each request has a unique id.
source	string	cloudevent field: For Kafka triggers, the value is /faas/event/kafka/{trigger_id}.
type	string	cloudevent field: event type. For Kafka triggers, the value is faas.kafka.event.
specversion	string	cloudevent field: cloudevent version.
datacontenttype	string	cloudevent field: message type. The value is always application/octet-stream.
time	string	The time when the message is triggered, which is in the ISO 8601 format.
data	string	The message content.
extensions	-	The extension information of the event. For the descriptions of sub-parameters, see the following extensions parameter descriptions.

The extensions parameters are described as follows:

Parameter	Type	Description
topic	string	The Topic of the message source.
partition	string	The partition of the message source.
consumergroup	string	The consumer group of the message source.
offset	string	The consumer offset.
key	string	The message key.

BMQ trigger

The structure of the BMQ trigger event message is as follows:

Parameter	Type	Description
id	string	cloudevent field: request id. Each request has a unique id.
source	string	cloudevent field: For BMQ triggers, the value is /faas/event/bmq/{trigger_id}.
type	string	cloudevent field: event type. For BMQ triggers, the value is faas.bmq.event.
specversion	string	cloudevent field: cloudevent version.
datacontenttype	string	cloudevent field: message type. The value is always application/octet-stream.
time	string	The time when the message is triggered, which is in the ISO 8601 format.
data	string	The message content.
extensions	-	The extension information of the event. For the descriptions of sub-parameters, see the following extensions parameter descriptions.

The extensions parameters are described as follows:

Parameter	Type	Description
topic	string	The Topic of the message source.
partition	string	The partition of the message source.
consumergroup	string	The consumer group of the message source.
offset	string	The consumer offset.
key	string	The message key.

RocketMQ trigger

The structure of the RocketMQ trigger event message is as follows:

Parameter	Type	Description
id	string	cloudevent field: request id. Each request has a unique id.
source	string	CloudEvent field: For RocketMQ triggers, the value is /faas/event/rocketmq/{trigger_id}.
type	string	cloudevent field: event type. For RocketMQ triggers, the value is faas.rocketmq.event.
specversion	string	cloudevent field: cloudevent version.
datacontenttype	string	cloudevent field: message type. The value is always application/octet-stream.
time	string	The time when the message is triggered, which is in the ISO 8601 format.
data	string	The message content.
extensions	-	The extension information of the event. For the descriptions of sub-parameters, see the following extensions parameter descriptions.

The extensions parameters are described as follows:

Parameter	Type	Description
topic	string	The Topic of the message source.
queueid	string	The queue id of the message source.
consumergroup	string	The consumer group of the message source.
offset	string	The consumer offset.
msgid	string	The message id.
tags	string	The message tags.

TOS trigger

The structure of the TOS trigger event message is as follows:

Parameter	Type	Description
specversion	string	cloudevent field: cloudevent version.
id	string	cloudevent field: request id. Each request has a unique id.
source	string	cloudevent field: For TOS triggers, the value is /faas/event/tos/{bucket_name}.
type	string	cloudevent field: event type. For TOS triggers, the value is faas.tos.event.
datacontenttype	string	cloudevent field: message type. The value is always application/octet-stream.
time	string	The time when the message is triggered, which is in the ISO 8601 format.
data	string	The specific content of the TOS event notification. For detailed descriptions, see TOS events.

TLS trigger

The structure of the TLS trigger event message is as follows:

Parameter	Type	Description
id	string	cloudevent field: request id. Each request has a unique id.
source	string	cloudevent field: For TLS triggers, the value is /faas/event/tls/{trigger_id}.
type	string	cloudevent field: event type. For TLS triggers, the value is faas.tls.event.
specversion	string	cloudevent field: cloudevent version.
datacontenttype	string	cloudevent field: message type. The value is always application/octet-stream.
time	string	The time when the message is triggered, which is in the ISO 8601 format.
data	json	The TLS log message content. Among them, __path__, __source__, __tag____client_ip__, and __tag____receive_time__ are TLS fields. Others are user-defined fields in the output log.
extensions	json	The extension information of the event. For the descriptions of sub-parameters, see the following extensions parameter descriptions.

The extensions parameters are described as follows:

Parameter	Type	Description
topic	string	The Topic of the message source.
partition	string	The partition of the message source.
consumergroup	string	The consumer group of the message source.
offset	string	The consumer offset.
key	string	The message key.
retriesforbadstatusrequests	string	The number of retries for the message. n indicates the nth retry.
maxretrynum	string	The maximum number of retries for the message.

Volcano Engine Function as a Service