All Products
Search
Document Center

Function Compute:CreateTrigger

Last Updated:Sep 19, 2024

A trigger is created.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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.
OperationAccess levelResource typeCondition keyAssociated operation
fc:CreateTriggercreate
  • All Resources
    *
    none
none

Request syntax

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

Request parameters

ParameterTypeRequiredDescriptionExample
serviceNamestringYes

The name of the service.

demoService
functionNamestringYes

The name of the function.

demoFunction
bodyobjectNo

The definition of the trigger.

invocationRolestringNo

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
qualifierstringNo

The version or alias of the service.

LATEST
sourceArnstringNo

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.

acs:oss:cn-shanghai:12345:mybucket
triggerConfigstringYes

The configurations of the trigger. The configurations vary based on the trigger type. For more information about the format, see the following topics:

{"events": ["oss:ObjectCreated:*"], "filter": {"key": {"prefix": "/prefix", "suffix": ".zip"}}}
triggerNamestringYes

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 a hyphen (-).

oss_create_object_demo
triggerTypestringYes

The type of the trigger. Valid values:

oss
descriptionstringNo

The description of the trigger.

trigger for test
X-Fc-Account-IdstringNo

The ID of your Alibaba Cloud account.

188077086902****
X-Fc-DatestringNo

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-IdstringNo

The custom request ID.

my-test-trace-id

Response parameters

ParameterTypeDescriptionExample
headersobject
ETagstring

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.

createdTimestring

The time when the trigger was created.

2016-08-15T15:00:00.000+0000
invocationRolestring

The ARN of the RAM role that is used by the event source to invoke the function.

acs:ram::1234567890:role/fc-test
lastModifiedTimestring

The time when the trigger was last modified.

016-08-15T17:00:00.000+0000
qualifierstring

The version of the service.

LATEST
sourceArnstring

The ARN of the event source.

acs:oss:cn-shanghai:12345:mybucket
triggerConfigstring

The configurations of the trigger. The configurations vary based on the trigger type.

{"events": ["oss:ObjectCreated:*"], "filter": {"key": {"prefix": "/prefix", "suffix": ".zip"}}}
triggerNamestring

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
triggerTypestring

The trigger type. Valid values: oss, log, tablestore, timer, http, cdn_events, mns_topic, and eventbridge.

oss
descriptionstring

The description of the trigger.

trigger for test
triggerIdstring

The unique ID of the trigger.

3e270f2f-cef2-421a-bc86-ff4e8088****
domainNamestring

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
urlInternetstring

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
urlIntranetstring

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 timeSummary of changesOperation
2024-02-19The internal configuration of the API is changed, but the call is not affectedView Change Details
2021-06-30The request parameters of the API has changedView Change Details
2021-06-30The request parameters of the API has changedView Change Details
2021-06-30The request parameters of the API has changed. The response structure of the API has changedView Change Details