Use UpdateTrigger to modify a trigger - Function Compute - Alibaba Cloud -

Modifies a trigger.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

fc:UpdateTrigger

update

*All Resource

*

None

Request syntax

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

Path Parameters

Parameter	Type	Required	Description	Example
serviceName	string	Yes	The name of the service.	demoService
functionName	string	Yes	The name of the function.	demoFunction
triggerName	string	Yes	The name of the trigger.	demoTrigger

Request parameters

Parameter	Type	Required	Description	Example
If-Match	string	No	This parameter is used to ensure that the modified resource is consistent with the resource to be modified. You can obtain the parameter value from the responses of CreateTrigger, GetTrigger, and UpdateTrigger operations.	e19d5cd5af0378da05f63f891c7467af
body	object	No	The definition of the trigger.
invocationRole	string	No	The 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::123456xxxx:role/fc-test
qualifier	string	No	The version or alias of the service.	LATEST
triggerConfig	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: Object Storage Service (OSS) trigger: OSSTriggerConfig. Simple 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. EventBridge triggers: EventBridgeTriggerConfig.	{"events": ["oss:ObjectCreated:*"], "filter": {"key": {"prefix": "/prefix", "suffix": ".zip"}}}
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 elements

Element	Type	Description	Example
	object	The definition of the trigger.
createdTime	string	The time when the audio or video file 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::123456xxxx:role/fc-test
lastModifiedTime	string	The last modification time.	016-08-15T17:00:00.000+0000
qualifier	string	The version or alias of the service.	LATEST
sourceArn	string	The ARN of the event source.	acs:oss:cn-shanghai:12345xxxx: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.	demoTrigger
triggerType	string	The trigger type. Example 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
status	string	The current state of the trigger. This parameter is valid only for EventBridge-based triggers.	RUNNING
targetArn	string	The Alibaba Cloud Resource Name (ARN) of the function associated with the trigger.	acs:fc::123456xxxx:services/my-test-service.LATEST/functions/my-test-function

Examples

Success response

JSON format

{
  "createdTime": "2016-08-15T15:00:00.000+0000",
  "invocationRole": "acs:ram::123456xxxx:role/fc-test",
  "lastModifiedTime": "016-08-15T17:00:00.000+0000",
  "qualifier": "LATEST",
  "sourceArn": "acs:oss:cn-shanghai:12345xxxx:mybucket",
  "triggerConfig": "{\"events\": [\"oss:ObjectCreated:*\"], \"filter\": {\"key\": {\"prefix\": \"/prefix\", \"suffix\": \".zip\"}}}",
  "triggerName": "demoTrigger",
  "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",
  "status": "RUNNING",
  "targetArn": "acs:fc::123456xxxx:services/my-test-service.LATEST/functions/my-test-function"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.