All Products
Search

This Product

    Function Compute:UpdateTrigger

    Document Center

    Function Compute:UpdateTrigger

    Last Updated:Sep 23, 2024

    Modifies a trigger.

    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:UpdateTriggerupdate
    • All Resources
      *
      none
    		none

    Request syntax

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

    Request parameters

    ParameterTypeRequiredDescriptionExample
    If-MatchstringNo

    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
    serviceNamestringYes

    The name of the service.

    		demoService
    functionNamestringYes

    The name of the function.

    		demoFunction
    triggerNamestringYes

    The name of the trigger.

    		demoTrigger
    bodyobjectNo

    The definition of the trigger.

    invocationRolestringNo

    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
    qualifierstringNo

    The version or alias of the service.

    		LATEST
    triggerConfigstringNo

    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"}}}
    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 audio or video file 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::123456xxxx:role/fc-test
    lastModifiedTimestring

    The last modification time.

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

    The version or alias of the service.

    		LATEST
    sourceArnstring

    The ARN of the event source.

    		acs:oss:cn-shanghai:12345xxxx: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.

    		demoTrigger
    triggerTypestring

    The trigger type. Example 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
    statusstring

    The current state of the trigger. This parameter is valid only for EventBridge-based triggers.

    		RUNNING
    targetArnstring

    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

    Sample success responses

    JSONformat

    {
  "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

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

    Change history

    Change timeSummary of changesOperation
    2023-12-29The response structure of the API has changedView Change Details
    2021-06-30The request parameters of the API has changedView Change Details
    2021-06-30The response structure of the API has changedView Change Details