tencent cloud

$0 14-Day TrialExperience EdgeOne for acceleration and security protection!

Feedback

Serverless Cloud Function
DocumentationServerless Cloud FunctionTriggersTrigger Configuration Description
DocumentationServerless Cloud FunctionTriggersTrigger Configuration Description

Trigger Configuration Description

Last updated: 2024-12-02 19:58:17
When you call the trigger API CreateTrigger, the corresponding TriggerDesc parameter will be the trigger description, which can be used as instructed in this document.

Timer Trigger

Please directly enter a cron expression for this parameter. For more information, please see Timer Trigger Description.

Sample TriggerDesc

Triggered once every five minutes:
0 */5 * * * * *

API Gateway Trigger

Name
Type
Required
Description
api
No
API configuration of the created API gateway
service
No
Service configuration of the created API gateway
release
No
Release environment for the created API gateway

ApigwApi

Name
Type
Required
Description
authRequired
String
No
Whether authentication is required. Valid values: TRUE, FALSE. Default value: FALSE
requestConfig
No
Configuration of request backend API
isIntegratedResponse
String
No
Whether to use integrated response. Valid values: TRUE, FALSE. Default value: FALSE
IsBase64Encoded
String
No
Whether to enable Base64-encoding. Valid values: TRUE, FALSE. Default value: FALSE

ApigwApiRequestConfig

Name
Type
Required
Description
method
String
No
Method configuration of request backend API. Valid values: ANY, GET, HEAD, POST, PUT, DELETE

ApigwService

Name
Type
Required
Description
serviceId
String
No
Apigw Service ID (if this parameter is not passed in, a new service will be created)

ApigwRelease

Name
Type
Required
Description
environmentName
String
Yes
Release environment. Valid values: release, test, prepub. If this parameter is left empty, release will be used by default

Sample TriggerDesc

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

CKafka Trigger

Name
Type
Required
Description
maxMsgNum
String
Yes
A function invocation will be triggered once every time maxMsgNum CKafka messages are aggregated within 5 seconds
offset
String
Yes
offset is the position where consumption of CKafka messages starts. Currently, three values are supported: latest, earliest, and millisecond-level timestamp
retry
String
Yes
Maximum number of retries when the function reports an error

Sample TriggerDesc

{"maxMsgNum":100,"offset":"latest","retry":10000}
{"maxMsgNum":999,"offset":"1595927203000","retry":10}

API request description

To create a CKafka trigger by using an API request, the TriggerName field needs to be defined as the instanceId and topicName of the target CKafka instance in the following format:
[instanceId]-[topicName]. Below is a sample request:
TriggerName: "ckafka-8tfxzia3-test"

COS Trigger

Name
Type
Required
Description
event
String
Yes
filter
Yes
COS filename filter

CosFilter

Name
Type
Required
Description
Prefix
String
No
Prefix rule of file filter
Suffix
String
No
Suffix rule of file filter, which must begin with .

COS event conflict rules

Core concept: an event can trigger a function invocation at most once. If an event is bound to another product, it cannot be bound to a function.
Set at most one prefix filter and one suffix filter.
If the cos:ObjectCreated:* event is set but no prefix/suffix is set, subsequent binding to any event that starts with cos:ObjectCreated will fail.
The filter will be valid only if both the prefix and suffix are matched, and if there are conflicts with both the prefix and suffix, subsequent binding will fail.

Sample TriggerDesc

{"event":"cos:ObjectCreated:*","filter":{"Prefix":"","Suffix":""}}
Note:
When TriggerDesc is used as a trigger description, the JSON string must be continuous with no spaces contained.

API request description

To create a COS trigger by using an API request, the TriggerName field needs to be defined as the XML API access domain name of the target COS bucket. Below is an example:
TriggerName: "xxx.cos.ap-guangzhou.myqcloud.com"
Note:
The access domain name can be viewed in Bucket List > Basic Configuration > Basic Information in the COS console.

CMQ Trigger

Name
Type
Required
Description
filterType
String
No
Message filter type. 1: tag; 2: route match
filterKey
String
No
When filterType is 1, it indicates the message filter tag; when filterType is 2, it indicates the Binding Key

Sample TriggerDesc

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

API request description

To create a CMQ trigger by using an API request, the TriggerName field needs to be defined as CMQ Topic. Below is an example:
TriggerName: "Tabortest"

Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support
Hong Kong, China
+852 800 906 020 (Toll Free)
United States
+1 844 606 0804 (Toll Free)
United Kingdom
+44 808 196 4551 (Toll Free)
Canada
+1 888 605 7930 (Toll Free)
Australia
+61 1300 986 386 (Toll Free)
EdgeOne hotline
+852 300 80699
More local hotlines coming soon