有奖捉虫:云通信与企业服务文档专题,速来> HOT

1. 接口描述

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

该接口为监控数据接口,数据采集及统计方式与计费数据不同,仅供运营分析使用,不能用于计费对账参考。
查询播放数据,支持按流名称查询详细播放数据,也可按播放域名查询详细总数据,数据延迟4分钟左右。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeStreamPlayInfoList。
Version String 公共参数,本接口取值:2018-08-01。
Region String 公共参数,本接口不需要传递此参数。
StartTime String 起始时间点,接口查询支持两种时间格式:
1)YYYY-MM-DDThh:mm:ssZ:UTC时间格式,详见IOS日期格式说明文档: https://cloud.tencent.com/document/product/266/11732#I
2)yyyy-MM-dd HH:mm:ss:使用此格式时,默认代表北京时间。
开始时间和结束时间的格式需要保持一致。
示例值:2019-03-01T00:00:00+08:00
EndTime String 结束时间点,接口查询支持两种时间格式:
1)YYYY-MM-DDThh:mm:ssZ:UTC时间格式,详见IOS日期格式说明文档: https://cloud.tencent.com/document/product/266/11732#I
2)yyyy-MM-dd HH:mm:ss:使用此格式时,默认代表北京时间。
开始时间和结束时间的格式需要保持一致。结束时间和开始时间跨度不支持超过24小时,支持距当前时间一个月内的数据查询。
示例值:2019-03-01T00:00:00+08:00
PlayDomain String 播放域名,
若不填,则为查询所有播放域名的在线流数据。
示例值:5000.playdomain.com
StreamName String 流名称,精确匹配。
若不填,则为查询总体播放数据。
示例值:stream1
AppName String 推流路径,与播放地址中的AppName保持一致,会精确匹配,在同时传递了StreamName时生效。
若不填,则为查询总体播放数据。
示例值:live
ServiceName String 服务名称,可选值包括LVB(标准直播),LEB(快直播),不填则查LVB+LEB总值。
示例值:LVB

3. 输出参数

参数名称 类型 描述
DataInfoList Array of DayStreamPlayInfo 统计信息列表,时间粒度是1分钟。
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 请求示例

查询流的播放信息列表

输入示例

POST / HTTP/1.1
Host: live.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeStreamPlayInfoList
<公共请求参数>

{
    "PlayDomain": "5000.playdomain.com",
    "StreamName": "stream1",
    "EndTime": "2019-03-01T00:03:00+08:00",
    "StartTime": "2019-03-01T00:00:00+08:00"
}

输出示例

{
    "Response": {
        "DataInfoList": [
            {
                "Time": "2019-03-01T00:00:00+08:00",
                "Bandwidth": 10.0,
                "Flux": 75.0,
                "Request": 50,
                "Online": 10
            },
            {
                "Time": "2019-03-01T00:02:00+08:00",
                "Bandwidth": 20.0,
                "Flux": 150.0,
                "Request": 50,
                "Online": 20
            },
            {
                "Time": "2019-03-01T00:03:00+08: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 缺少参数错误。
ResourceNotFound.ForbidService 用户被禁用。
ResourceNotFound.FreezeService 用户服务被冻结。
ResourceNotFound.StopService 账号停服,请先冲正开通服务后再操作。
ResourceNotFound.UserDisableService 用户主动停服。