tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

ListAsyncEvents

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

1. API Description

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

This API is used to pull the list of async function events.

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: ListAsyncEvents.
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
Qualifier No String Filter (function version)
InvokeType.N No Array of String Filter (invocation type list)
Status.N No Array of String Filter (event status list)
StartTimeInterval No TimeInterval Filter (left-closed-right-open range of execution start time)
EndTimeInterval No TimeInterval Filter (left-closed-right-open range of execution end time)
Order No String Valid values: ASC, DESC. Default value: DESC
Orderby No String Valid values: StartTime, EndTime. Default value: StartTime
Offset No Integer Data offset. Default value: 0
Limit No Integer Number of results to be returned. Default value: 20. Maximum value: 100
InvokeRequestId No String Filter (event invocation request ID)

3. Output Parameters

Parameter Name Type Description
TotalCount Integer Total number of events that meet the filter
EventList Array of AsyncEvent Async event list
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Pulling async function event list

Input Example

https://scf.tencentcloudapi.com/?Action=ListAsyncEvents
&FunctionName=helloworld
&Qualifier=1
&Offset=0
&Limit=20
&<Common request parameters>

Output Example

{
    "Response": {
        "TotalCount": 2,
        "EventList": [
            {
                "InvokeRequestId": "xxxxxxxxxxxxxx",
                "Qualifier": "1",
                "Status": "FINISHED",
                "InvokeType": "COS",
                "StartTime": "2020-12-01 08:35:00.000",
                "EndTime": "2020-12-01 08:35:30.000"
            },
            {
                "InvokeRequestId": "xxxxxxxxxxxxxx",
                "Qualifier": "1",
                "Status": "RUNNING",
                "InvokeType": "COS",
                "StartTime": "2020-12-01 08:35:00.000",
                "EndTime": ""
            }
        ],
        "RequestId": "26c5f1a9-ebd4-407e-83d7-ae8001cca644"
    }
}

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
InvalidParameterValue.FunctionName The function does not exist.
InvalidParameterValue.InvokeType The InvokeType value does not conform to the specification. Please fix it and try again.
InvalidParameterValue.Limit Limit error.
InvalidParameterValue.Namespace Namespace error.
InvalidParameterValue.Order Order error.
InvalidParameterValue.Orderby Orderby error.
InvalidParameterValue.Status The Status value does not conform to the specification. Please fix it and try again.
ResourceNotFound.Function The function does not exist.
ResourceNotFound.Namespace Namespace does not exist.
ResourceNotFound.Version The version does not exist.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy