All Products
Search

This Product

    Function Compute:ListTriggers

    Document Center

    Function Compute:ListTriggers

    Last Updated:Jun 02, 2023

    Queries the triggers of a function.

    Authorization information

    There is currently no authorization information disclosed in the API.

    Request syntax

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

    Request parameters

    ParameterTypeRequiredDescriptionExample
    serviceNamestringYes

    The name of the function.

    		demo-service
    functionNamestringYes

    The maximum number of resources to return. Default value: 20. Maximum value: 100. The number of returned resources is less than or equal to the specified number.

    		demo-function
    limitintegerNo

    The token required to obtain more results. You do not need to provide this parameter in the first call. The tokens for subsequent queries are obtained from the returned results.

    		20
    nextTokenstringNo

    The prefix that the names of returned resources must contain.

    		f-trigger
    prefixstringNo

    The returned resources are sorted in alphabetical order, and the resources that include and follow the resource specified by the startKey parameter are returned.

    		a
    startKeystringNo

    The ID of your Alibaba Cloud account.

    		a-trigger
    X-Fc-Account-IdstringNo

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

    The custom request ID.

    		Wed, 11 May 2022 09:00:00 GMT
    X-Fc-Trace-IdstringNo

    The returned data.

    		my-test-trace-id

    Response parameters

    ParameterTypeDescriptionExample
    object

    The token used to obtain more results. If this parameter is left empty, all the results are returned.

    nextTokenstring

    The information about triggers.

    		f-trigger
    triggersobject []

    The details of the trigger.

    createdTimestring

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

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

    The time when the trigger was last modified.

    		acs:ram::123456xxxx:role/fc-test
    lastModifiedTimestring

    The version or alias of the service.

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

    The ARN of the event source.

    		LATEST
    sourceArnstring

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

    		acs:oss:cn-shanghai:123456xxxx:mybucket
    triggerConfigstring

    The name of the trigger.

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

    The trigger type, such as oss, log, tablestore, timer, http, cdn_events, and mns_topic.

    		demoTrigger
    triggerTypestring

    The description of the trigger.

    		oss
    descriptionstring

    The unique ID of the trigger.

    		trigger for test
    triggerIdstring

    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****
    domainNamestring

    The public domain address. You can access HTTP triggers over the Internet by using HTTP or HTTPS.

    		demo-service-demo-function-jkhksh
    urlInternetstring

    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

    {
  "nextToken": "f-trigger",
  "triggers": [
    {
      "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:123456xxxx: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"
    }
  ]
}

    Error codes

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

    Change history

    Change timeSummary of changesOperation
    2021-06-30The input parameters of the API operation change.
    Change itemChange content
    Input ParametersThe 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-30The input parameters of the API operation change.
    Change itemChange content
    Input ParametersThe input parameters of the API operation change.
      Added Input Parameters: X-Fc-Account-Id
    2021-06-30The input parameters of the API operation change.,The response structure of the API operation changes.
    Change itemChange content
    Input ParametersThe input parameters of the API operation change.
      delete Input Parameters: X-Fc-Account-Id
    Output ParametersThe response structure of the API operation changes.