API 文档

查询流的播放信息列表

最近更新时间:2021-02-04 08:24:37

我的收藏

1. 接口描述

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

查询播放数据,支持按流名称查询详细播放数据,也可按播放域名查询详细总数据,数据延迟4分钟左右。 注意:按AppName查询请先联系工单申请,开通后配置生效预计需要5个工作日左右,具体时间以最终回复为准。

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

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeStreamPlayInfoList。
Version String 公共参数,本接口取值:2018-08-01。
Region String 公共参数,本接口不需要传递此参数。
StartTime String 开始时间,北京时间,格式为yyyy-mm-dd HH:MM:SS
EndTime String 结束时间,北京时间,格式为yyyy-mm-dd HH:MM:SS,
结束时间 和 开始时间跨度不支持超过24小时,支持距当前时间30天内的数据查询。
PlayDomain String 播放域名,
若不填,则为查询所有播放域名的在线流数据。
StreamName String 流名称,精确匹配。
若不填,则为查询总体播放数据。
AppName String 推流路径,与播放地址中的AppName保持一致,会精确匹配,在同时传递了StreamName时生效。
若不填,则为查询总体播放数据。
注意:按AppName查询请先联系工单申请,开通后配置生效预计需要5个工作日左右,具体时间以最终回复为准。
ServiceName String 服务名称,可选值包括LVB(标准直播),LEB(快直播),不填则查LVB+LEB总值。

3. 输出参数

参数名称 类型 描述
DataInfoList Array of DayStreamPlayInfo 统计信息列表,时间粒度是1分钟。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 请求示例

输入示例

https://live.tencentcloudapi.com/?Action=DescribeStreamPlayInfoList
&PlayDomain=5000.playdomain.com
&StreamName=stream1
&StartTime=2019-03-01 00:00:00
&EndTime=2019-03-01 00:03:00
&<公共请求参数>

输出示例

{
  "Response": {
    "DataInfoList": [
      {
        "Time": "2019-03-01 00:00:00",
        "Bandwidth": 10.0,
        "Flux": 75.0,
        "Request": 50,
        "Online": 10
      },
      {
        "Time": "2019-03-01 00:02:00",
        "Bandwidth": 20.0,
        "Flux": 150.0,
        "Request": 50,
        "Online": 20
      },
      {
        "Time": "2019-03-01 00:03:00",
        "Bandwidth": 30.0,
        "Flux": 225.0,
        "Request": 50,
        "Online": 30
      }
    ],
    "RequestId": "8e50cdb5-56dc-408b-89b0-31818958d424"
  }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败。
InternalError 内部错误。
InternalError.DBError DB执行错误。
InvalidParameterValue 参数取值错误。
MissingParameter 缺少参数错误。
目录