查询推断流事件

最近更新时间:2019-07-25 20:28:04

1. 接口描述

接口请求域名: live.tencentcloudapi.com 。

用于查询推断流事件。

注意:该接口可通过使用IsFilter进行过滤,返回推流历史记录。

默认接口请求频率限制:500次/秒。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeLiveStreamEventList
Version String 公共参数,本接口取值:2018-08-01
Region String 公共参数,本接口不需要传递此参数。
StartTime String 起始时间。
UTC 格式,例如:2018-12-29T19:00:00Z。
支持查询60天内的历史记录。
EndTime String 结束时间。
UTC 格式,例如:2018-12-29T20:00:00Z。
不超过当前时间,且和起始时间相差不得超过30天。
AppName String 推流路径,与推流和播放地址中的AppName保持一致,默认为 live。
DomainName String 推流域名。
StreamName String 流名称,不支持通配符(*)查询,默认模糊匹配。
可使用IsStrict字段改为精确查询。
PageNum Integer 取得第几页。
默认值:1。
注: 目前只支持10000条内的查询。
PageSize Integer 分页大小。
最大值:100。
取值范围:1~100 之前的任意整数。
默认值:10。
注: 目前只支持10000条内的查询。
IsFilter Integer 是否过滤,默认不过滤。
0:不进行任何过滤。
1:过滤掉开播失败的,只返回开播成功的。
IsStrict Integer 是否精确查询,默认模糊匹配。
0:模糊匹配。
1:精确查询。
注:使用StreamName时该参数生效。
IsAsc Integer 是否按结束时间正序显示,默认逆序。
0:逆序。
1:正序。

3. 输出参数

参数名称 类型 描述
EventList Array of StreamEventInfo 推断流事件列表。
PageNum Integer 分页的页码。
PageSize Integer 每页大小。
TotalNum Integer 符合条件的总个数。
TotalPage Integer 总页数。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 请求示例

输入示例

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
&<公共请求参数>

输出示例

{
  "Response": {
    "EventList": [
      {
        "AppName": "live",
        "ClientIp": "180.163.8.244",
        "DomainName": "5000.livepush.myqcloud.com",
        "Duration": 0,
        "Resolution": "640*352",
        "StopReason": "客户端主动断流",
        "StreamEndTime": "2019-01-04T11:59:58Z",
        "StreamName": "5000_b6c808121b0d11e6b91fa4dcbef5e35a",
        "StreamStartTime": "2019-01-04T11:59:58Z"
      }
    ],
    "PageNum": 1,
    "PageSize": 10,
    "TotalNum": 100,
    "TotalPage": 10,
    "RequestId": "8e50cdb5-56dc-408b-89b0-31818958d424"
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation 操作失败
FailedOperation.CallOtherSvrFailed 调用内部服务失败。
InternalError 内部错误
InvalidParameterValue 参数取值错误
MissingParameter 缺少参数错误
ResourceNotFound.UserNotExist 用户未注册直播。