tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

ListTriggers

Last updated: 2023-07-18 11:10:58

1. API Description

Domain name for API request: scf.tencentcloudapi.com.

This API is used to get the function trigger list.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: ListTriggers.
Version Yes String Common Params. The value used for this API: 2018-04-16.
Region No String Common Params. This parameter is not required for this API.
FunctionName Yes String Function name
Namespace No String Namespace. Default value: default
Offset No Integer Data offset. Default value: 0
Limit No Integer Number of results to be returned. Default value: 20
OrderBy No String Indicates by which field to sort the returned results. Valid values: add_time, mod_time. Default value: mod_time
Order No String Indicates whether the returned results are sorted in ascending or descending order. Valid values: ASC, DESC. Default value: DESC
Filters.N No Array of Filter * Qualifier: Version/Alias of trigger function
*TriggerName: Name of the trigger
*Description: Function trigger description

3. Output Parameters

Parameter Name Type Description
TotalCount Integer Total number of triggers
Triggers Array of TriggerInfo Trigger list
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Obtaining the list of function triggers

This example shows you how to get the list of function triggers.

Input Example

https://scf.tencentcloudapi.com/?Action=ListTriggers 
&FunctionName=aaa 
&Limit=2 
&Order=ASC 
&<Common request parameters>

Output Example

{
    "Response": {
        "TotalCount": 1,
        "Triggers": [
            {
                "Enable": 1,
                "Qualifier": "abc",
                "TriggerName": "abc",
                "Type": "abc",
                "TriggerDesc": "abc",
                "AvailableStatus": "abc",
                "CustomArgument": "abc",
                "Description": "abc",
                "AddTime": "9/22/2020 12:00:00 AM",
                "ModTime": "2020-09-22 00:00:00",
                "ResourceId": "abc",
                "BindStatus": "abc",
                "TriggerAttribute": "abc"
            }
        ],
        "RequestId": "abc"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
FailedOperation.Apigw Failed to create the trigger.
InvalidParameterValue.Filters Filters parameter error.
InvalidParameterValue.Order Order error.
InvalidParameterValue.OrderBy The value of OrderBy does not conform to the specification. Please fix it and try again. For more information, please visit https://tencentcs.com/5jXKFnBW.
InvalidParameterValue.Orderby Orderby error.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy