查询直播流数据--慢直播-火山引擎

文档中心

立即注册

导航

查询直播流数据

最近更新时间：2023.10.13 15:11:29首次发布时间：2023.10.13 14:59:21

查询来自直播的视频流信息。

请求方式

使用 POST 方式发起请求。

请求参数

下表仅列出了接口特有的请求参数和部分公共参数。完整的公共参数列表，参考「公共参数」。

字段	位置	类型	必填	说明	值
Action	Query	String	是	公共参数，OpenAPI 接口名称	StatStream
Version	Query	String	是	公共参数，OpenAPI 接口版本	2021-01-01

Body 参数

字段	类型	必填	说明
StreamID	String	是	视频流 ID；可通过调用 ListStreams 接口获取
StartTime	Integer	是	查询起始时间；Unix 时间戳，精确到秒，例如：1697166403
EndTime	Integer	是	查询结束时间；Unix 时间戳，精确到秒，例如：1697169407
Aggregation	Integer	是	数据聚合周期；支持60和300，单位：秒

返回结果

返回参数说明

通用返回参数，请参考 ResponseMetadata 结构体说明。

Result 字段包含以下参数：

字段	类型	说明
SessionData	Array of objects	查询到的直播视频流信息列表，参考以下直播视频流数据结构说明

直播视频流数据结构说明

字段	类型	说明
Timestamp	Integer	视频流时间片开始时刻，Unix 时间戳，单位：秒
OnlineUser	Integer	直播在线人数
Request	Integer	请求数

示例

请求示例

POST https://open.volcengineapi.com?Action=StatStream
&Version=2021-01-01
&<公共请求参数>

{
    "StreamID": "2a772f0b-753c-4496-b535-a8df0fxxxxxx",
    "StartTime": 1697166403,
    "EndTime": 1697169407,
    "Aggregation": 60
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202209141422410102040570671202A65A",
        "Action": "StatStream",
        "Version": "2021-01-01",
        "Service": "aiotvideo",
        "Region": "cn-north-1"
    },
    "Result": {
        "SessionData": [
            {
                "Timestamp": 1697167403,
                "OnlineUser": 10,
                "Request": 20
            },
            {
                "Timestamp": 1697168407,
                "OnlineUser": 15,
                "Request": 30
            }
        ]
    }
}