CreateTrigger - Function Compute - Alibaba Cloud Documentation Center

A trigger is created.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
fc:CreateTrigger	create	All Resources *	none	none

Request syntax

POST /2021-04-06/services/{serviceName}/functions/{functionName}/triggers HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
serviceName	string	Yes	The name of the service.	demoService
functionName	string	Yes	The name of the function.	demoFunction
body	object	No	The definition of the trigger.
invocationRole	string	No	The RAM role that is used by the event source such as Object Storage Service (OSS) to invoke the function. For more information, see Overview .	acs:ram::1234567890:role/fc-test
qualifier	string	No	The version or alias of the service.	LATEST
sourceArn	string	No	The Alibaba Cloud Resource Name (ARN) of the trigger event source. This parameter is optional for time triggers, HTTP triggers, and EventBridge-based triggers. This parameter is required for other types of triggers. For an EventBridge-based trigger, if you specify this parameter, the existing resources on the EventBridge side are associated with the trigger. Do not specify the same sourceArn value for two different EventBridge triggers. Otherwise, the update and delete operations of one trigger affect another.	acs:oss:cn-shanghai:12345:mybucket
triggerConfig	string	Yes	The trigger configurations. The configurations vary based on the trigger type. The following items list the configuration format for different triggers: OSS triggers: OSSTriggerConfig . Simple Log Service triggers: LogTriggerConfig . Time triggers: TimeTriggerConfig . HTTP triggers: HTTPTriggerConfig Tablestore triggers: Specify the SourceArnm parameter and leave this parameter empty. Alibaba Cloud CDN event triggers: CDNEventsTriggerConfig . Simple Message Queue (formerly MNS) (SMQ) topic triggers: MnsTopicTriggerConfig . EventBridge-based triggers: EventBridgeTriggerConfig .	{"events": ["oss:ObjectCreated:*"], "filter": {"key": {"prefix": "/prefix", "suffix": ".zip"}}}
triggerName	string	Yes	The name of the trigger. The name can contain only letters, digits, hyphens (-), and underscores (_). The name must be 1 to 128 characters in length and cannot start with a digit or a hyphen (-).	oss_create_object_demo
triggerType	string	Yes	The type of the trigger. Valid values: oss: OSS event trigger. For more information, see Overview of OSS event triggers. log: Simple Log Service trigger. For more information, see Simple Log Service triggers. timer: time trigger. For more information, see Configure a time trigger. http: HTTP trigger. For more information, see Overview . tablestore: Tablestore trigger. For more information, see Tablestore triggers. cdn_events: Alibaba Cloud CDN event triggers. For more information, see Overview . mns_topic: SMQ topic triggers. For more information, see Simple Message Queue (formerly MNS) topic triggers. eventbridge: EventBridge-based triggers.	oss
description	string	No	The description of the trigger.	trigger for test
X-Fc-Account-Id	string	No	The ID of your Alibaba Cloud account.	188077086902****
X-Fc-Date	string	No	The time when the request is initiated on the client. The format of the value is: EEE,d MMM yyyy HH:mm:ss GMT.	Wed, 11 May 2022 09:00:00 GMT
X-Fc-Trace-Id	string	No	The custom request ID.	my-test-trace-id

Response parameters

Parameter	Type	Description	Example
headers	object
ETag	string	The ETag that is used to modify the trigger. This parameter is used to ensure that the modified trigger is consistent with the trigger to be modified.	5e547e5605e1dc17a78a6191bc18fbc5
	object	The definition of the trigger.
createdTime	string	The time when the trigger was created.	2016-08-15T15:00:00.000+0000
invocationRole	string	The ARN of the RAM role that is used by the event source to invoke the function.	acs:ram::1234567890:role/fc-test
lastModifiedTime	string	The time when the trigger was last modified.	016-08-15T17:00:00.000+0000
qualifier	string	The version of the service.	LATEST
sourceArn	string	The ARN of the event source.	acs:oss:cn-shanghai:12345:mybucket
triggerConfig	string	The configurations of the trigger. The configurations vary based on the trigger type.	{"events": ["oss:ObjectCreated:*"], "filter": {"key": {"prefix": "/prefix", "suffix": ".zip"}}}
triggerName	string	The name of the trigger. The name contains only letters, digits, hyphens (-), and underscores (_). The name must be 1 to 128 characters in length and cannot start with a digit or hyphen (-).	oss_create_object_trigger_demo
triggerType	string	The trigger type. Valid values: oss, log, tablestore, timer, http, cdn_events, mns_topic, and eventbridge.	oss
description	string	The description of the trigger.	trigger for test
triggerId	string	The unique ID of the trigger.	3e270f2f-cef2-421a-bc86-ff4e8088****
domainName	string	The domain name used to invoke the function by using HTTP. You can add this domain name as the prefix to the endpoint of Function Compute. This way, you can invoke the function that corresponds to the trigger by using HTTP. For example, `{domainName}.cn-shanghai.fc.aliyuncs.com`.	demo-service-demo-function-jkhksh
urlInternet	string	The public domain address. You can access HTTP triggers over the Internet by using HTTP or HTTPS.	https://svc-func-xxxxxxxx.cn-hangzhou.fcapp.run
urlIntranet	string	The private endpoint. In a VPC, you can access HTTP triggers by using HTTP or HTTPS.	https://svc-func-xxxxxxxx.cn-hangzhou-vpc.fcapp.run

Examples

Sample success responses

JSONformat

{
  "createdTime": "2016-08-15T15:00:00.000+0000",
  "invocationRole": "acs:ram::1234567890:role/fc-test",
  "lastModifiedTime": "016-08-15T17:00:00.000+0000",
  "qualifier": "LATEST",
  "sourceArn": "acs:oss:cn-shanghai:12345:mybucket",
  "triggerConfig": "{\"events\": [\"oss:ObjectCreated:*\"], \"filter\": {\"key\": {\"prefix\": \"/prefix\", \"suffix\": \".zip\"}}}",
  "triggerName": "oss_create_object_trigger_demo",
  "triggerType": "oss",
  "description": "trigger for test",
  "triggerId": "3e270f2f-cef2-421a-bc86-ff4e8088****",
  "domainName": "demo-service-demo-function-jkhksh",
  "urlInternet": "https://svc-func-xxxxxxxx.cn-hangzhou.fcapp.run",
  "urlIntranet": "https://svc-func-xxxxxxxx.cn-hangzhou-vpc.fcapp.run"
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-02-19	The internal configuration of the API is changed, but the call is not affected	View Change Details
2021-06-30	The request parameters of the API has changed	View Change Details
2021-06-30	The request parameters of the API has changed	View Change Details
2021-06-30	The request parameters of the API has changed. The response structure of the API has changed	View Change Details