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

文档中心

立即注册

导航

StatStream - 查询直播流数据

最近更新时间：2025.06.06 17:05:49首次发布时间：2023.10.13 14:59:21

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

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com?Action=StatStream&Version=2021-01-01

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	StatStream	要执行的操作，取值：StatStream。
Version	String	是	2021-01-01	API的版本，取值：2021-01-01。
StreamID	String	是	2a772f0b-753c-4496-b535-a8df0fxxxxxx	视频流 ID；可通过调用 ListStreams 接口获取
StartTime	Integer	是	1697166403	查询起始时间；Unix 时间戳，精确到秒，例如：1697166403
EndTime	Integer	是	1697169407	查询结束时间；Unix 时间戳，精确到秒，例如：1697169407
Aggregation	Integer	是	60	数据聚合周期；支持60和300，单位：秒

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
SessionData	Object		查询到的直播视频流信息列表，参考以下直播视频流数据结构说明

请求示例

POST /?Action=StatStream&Version=2021-01-01 HTTP/1.1
Host: open.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20241219T032534Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20241219/cn-beijing/aiotvideo/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

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

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20241219112538098202058162F6713C",
    "Action": "StatStream",
    "Version": "2021-01-01",
    "Service": "aiotvideo",
    "Region": "cn-beijing"
  },
  "Result": {
    "SessionData": {
      "Timestamp": 1697168407,
      "OnlineUser": 15,
      "Request": 30
    }
  }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	ErrorMissingParameter	MissingParameter