CreateTrigger - Function Compute - Alibaba Cloud Documentation Center

A trigger is created.

Authorization information

There is currently no authorization information disclosed in the API.

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
serviceName	string	Yes	The name of the function.	demoService
functionName	string	Yes	The definition of the trigger.	demoFunction
body	object	Yes	The role that is used by the event source such as OSS to invoke the function. For more information, see Overview.
invocationRole	string	No	The version or alias of the service.	acs:ram::1234567890:role/fc-test
qualifier	string	No	The Alibaba Cloud Resource Name (ARN) of the event source for the trigger.	LATEST
sourceArn	string	No	The configurations of the trigger. The configurations vary based on the trigger type. For more information about the format, see the following topics: OSS trigger: OSSTriggerConfig. Log Service trigger: LogTriggerConfig. Time trigger: TimeTriggerConfig. HTTP trigger: HTTPTriggerConfig. Tablestore trigger: Specify the SourceArn parameter and leave this parameter empty. Alibaba Cloud CDN event trigger: CDNEventsTriggerConfig. MNS topic trigger: MnsTopicTriggerConfig.	acs:oss:cn-shanghai:12345:mybucket
triggerConfig	string	Yes	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 (-).	{"events": ["oss:ObjectCreated:*"], "filter": {"key": {"prefix": "/prefix", "suffix": ".zip"}}}
triggerName	string	Yes	The type of the trigger. Valid values: oss: OSS event trigger. For more information, see Overview. log: Log Service trigger. For more information, see Overview. timer: time trigger. For more information, see Overview. http: HTTP trigger. For more information, see Overview. tablestore: Tablestore trigger. For more information, see Overview. cdn_events: CDN event trigger. For more information, see Overview. mns_topic: MNS topic trigger. For more information, see Overview.	oss_create_object_demo
triggerType	string	Yes	The description of the trigger. Enumeration Value: cdn_events timer log mns_topic eventbridge http oss tablestore	oss
description	string	No	The ID of your Alibaba Cloud account.	trigger for test
X-Fc-Account-Id	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.	188077086902****
X-Fc-Date	string	No	The custom request ID.	Wed, 11 May 2022 09:00:00 GMT
X-Fc-Trace-Id	string	No	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.	my-test-trace-id

Response parameters

Parameter	Type	Description	Example
headers	object
ETag	string	The definition of the trigger.	5e547e5605e1dc17a78a6191bc18fbc5
	object	The time when the trigger was created.
createdTime	string	The ARN of the RAM role that is used by the event source to invoke the function.	2016-08-15T15:00:00.000+0000
invocationRole	string	The time when the trigger was last modified.	acs:ram::1234567890:role/fc-test
lastModifiedTime	string	The version of the service.	016-08-15T17:00:00.000+0000
qualifier	string	The ARN of the event source.	LATEST
sourceArn	string	The configurations of the trigger. The configurations vary based on the trigger type.	acs:oss:cn-shanghai:12345:mybucket
triggerConfig	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 (-).	{"events": ["oss:ObjectCreated:*"], "filter": {"key": {"prefix": "/prefix", "suffix": ".zip"}}}
triggerName	string	The trigger type, such as oss, log, tablestore, timer, http, cdn_events, and mns_topic.	oss_create_object_trigger_demo
triggerType	string	The description of the trigger.	oss
description	string	The unique ID of the trigger.	trigger for test
triggerId	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`.	3e270f2f-cef2-421a-bc86-ff4e8088****
domainName	string	The public domain address. You can access HTTP triggers over the Internet by using HTTP or HTTPS.	demo-service-demo-function-jkhksh
urlInternet	string	The private endpoint. In a VPC, you can access HTTP triggers by using HTTP or HTTPS.	https://svc-func-xxxxxxxx.cn-hangzhou.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

2021-06-30

The input parameters of the API operation change.

Change item	Change content
Input Parameters	The input parameters of the API operation change.
	Added Input Parameters: X-Fc-Account-Id
	Added Input Parameters: X-Fc-Code-Checksum
	Added Input Parameters: X-Fc-Log-Type
	Added Input Parameters: X-Fc-Invocation-Type
	Added Input Parameters: X-Fc-Date
	Added Input Parameters: X-Fc-Trace-Id

2021-06-30

The input parameters of the API operation change.

Change item	Change content
Input Parameters	The input parameters of the API operation change.
	Added Input Parameters: X-Fc-Account-Id

2021-06-30

The input parameters of the API operation change.,The response structure of the API operation changes.

Change item	Change content
Input Parameters	The input parameters of the API operation change.
	delete Input Parameters: X-Fc-Account-Id
Output Parameters	The response structure of the API operation changes.