DescribeLiveStreamEventList

Last updated: 2019-06-25 22:24:46

## 1. API Description

API request domain name: live.tencentcloudapi.com.

This API queries streaming events.

Default API request rate limit: 500 requests/second.

2. Request Parameters

The following parameters are required for requesting this API, including action-specific parameters and common parameters. For more information about common parameters for all requests, see Common Request Parameters.

Parameter name Required Type Description
Action Yes String Common parameter; the name of this API: DescribeLiveStreamEventList
Version Yes String Common parameter; the version of this API: 2018-08-01
Region No String Common parameter; optional for this API
StartTime Yes String Start time In UTC format, for example: 2018-12-29T19:00:00Z.
This supports querying the history of 60 days.
EndTime Yes String End time In UTC format, for example: 2018-12-29T20:00:00Z.
This cannot be after the current time and cannot be more than 30 days after the start time.
AppName No String Application name
DomainName No String Upstream domain name.
StreamName No String Stream name; query with wildcard (*) is not supported; fuzzy match by default.
The IsStrict field can be used to change to exact query.
PageNum No Integer The page number to get.
Default value: 1.
Note: Currently, query for up to 10,000 entries is supported.
PageSize No Integer Page size.
Maximum value: 100.
Value range: any integer between 1 and 100.
Default value: 10.
Note: Currently, query for up to 10,000 entries is supported.
IsFilter No Integer Whether to filter; no filtering by default.
0: No filtering at all.
1: Filter out the failed streams and return only the successful ones.
IsStrict No Integer Whether to query exactly; fuzzy match by default.
0: Fuzzy match.
1: Exact query.
Note: This parameter takes effect when StreamName is used.
IsAsc No Integer Whether to display in ascending order by end time; descending order by default.
0: Descending.
1: Ascending.

3. Return Parameters

Parameter name Type Description
EventList Array of StreamEventInfo Streaming event list
PageNum Integer Page number.
PageSize Integer Size per page
TotalNum Integer Total number of eligible ones.
TotalPage Integer Total number of pages.
RequestId String The ID of the request. Each request returns a unique ID. The RequestId is required to troubleshoot issues.

4. Sample

Request Sample

Input Sample Code

https://live.tencentcloudapi.com/?Action=DescribeLiveStreamEventList
&DomainName=5000.livepush.com
&AppName=live
&StreamName=stream1
&StartTime=2019-01-04T12:00:00Z
&EndTime=2019-01-04T20:00:00Z
&PageNum=1
&PageSize=10
&IsFilter=1
&IsStrict=0
&IsAsc=0
&<Common request parameter>

Output Sample Code

{
    "Response": {
        "EventList": [
                       {
                              "AppName": "live",
                              "ClientIp": "180.163.8.244",
                              "DomainName": "5000.livepush.myqcloud.com",
                              "Duration": 0,
                              "Resolution": "640*352",
                              "StopReason": "Client actively interrupts the push (3)",
                              "StreamEndTime": "2019-01-04T11:59:58Z",
                              "StreamName": "5000_b6c808121b0d11e6b91fa4dcbef5e35a",
                              "StreamStartTime": "2019-01-04T11:59:58Z",
                              "Url": "rtmp://22318.livepush.myqcloud.com/live/stream_id_2"
                       }
                ],
        "PageNum": 1,
        "PageSize": 10,
        "TotalNum": 100,
        "TotalPage": 10,
        "RequestId": "8e50cdb5-56dc-408b-89b0-31818958d424"
    }
}

5. Developer Resources

API Explorer

API Explorer is a tool that provides ease of use in requesting APIs, authenticating identities, generating SDK and exploring APIs in Tencent Cloud environment.

SDK

Cloud API 3.0 comes with a set of complementary development toolkits (SDKs) that support multiple programming languages and make it easier to call the API.

TCCLI

6. Error Codes

The following error codes are API business logic-related. For other error codes, see Common Error Codes.

Error Code Description
InternalError Internal error
InvalidParameterValue Incorrect parameter value
MissingParameter Missing parameter