DescribeLiveStreamUsageData - 查询指定时间流和协议维度的数据--视频直播-火山引擎

文档中心

立即注册

导航

视频直播

DescribeLiveStreamUsageData - 查询指定时间流和协议维度的数据

最近更新时间：2024.12.09 11:16:59首次发布时间：2023.10.24 19:58:33

调用 DescribeLiveStreamUsageData 接口，查询指定时间流和协议维度的带宽、在线人数和请求数数据。

注意事项

请求频率：单用户请求频率限制为 30 次/秒。
数据延迟：数据延迟为 5 分钟。

请求说明

请求方式：POST
请求地址：https://live.volcengineapi.com?Action=DescribeLiveStreamUsageData&Version=2023-01-01

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`DescribeLiveStreamUsageData`	接口名称。当前 API 的名称为 `DescribeLiveStreamUsageData`。
Version	String	是	`2023-01-01`	接口版本。当前 API 的版本为 `2023-01-01`。

Body

参数	类型	是否必选	示例值	描述
Domain	String	否	`example.com`	域名。
StreamName	String	否	`stream001`	流名称。
QueryTime	String	否	`2022-04-13 10:00`	查询时间，格式为 yyyy-mm-dd HH:MM。例如：查询时间 2023-01-01 10:00 时表示查询时间范围为 10:00 到 10:01。说明未填写查询时间时，默认查询时间为当前时间减 5 分钟。最长支持查询的历史时间范围为 31 天。

返回参数

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

参数类型示例值描述

参数	类型	示例值	描述
Status	Integer	`1`	请求状态： 1：请求成功 0：请求失败
Result	String	`-`	请求失败原因：请求成功时 Result 为空请求失败时 Result 展示失败的原因
Response	Object of Response	`-`	响应数据。

Status

Integer

1

请求状态：

1：请求成功
0：请求失败

Result

String

-

请求失败原因：

请求成功时 Result 为空
请求失败时 Result 展示失败的原因

Response Object of Response - 响应数据。

Response

参数	类型	示例值	描述
QueryTime	String	`2022-04-13 10:00`	查询时间。
RequestId	String	`k54e3deb-f318-****-8a68-3c959642f9ec`	请求 ID。
DataInfoList	Array of DataInfoList	`-`	详细数据信息。

DataInfoList

参数	类型	示例值	描述
Bandwidth	Integer	`20`	带宽，单位 kbps。
Protocol	String	`P2p`	协议。
Request	Integer	`10`	请求数。
OnlineUser	Integer	`10`	在线人数。
Domain	String	`example.com`	域名
StreamName	String	`test`	流名称。

请求示例

GET https://live.volcengineapi.com?Action=DescribeLiveStreamUsageData&Version=2023-01-01
{
    "Domain": "example.com",
    "QueryTime": "2022-04-13 10:00"
}

返回示例

{ 
  "Status": 0,
  "Result": "",
  "Response":{
    "QueryTime": "2021-04-13 00:00",
    "DataInfoList": [
       {
            "StreamName":"stream001",
            "Domain":"example.com",
            "Bandwidth":12,
            "Protocol":"Hls",
            "Request":10,
            "OnlineUser":20
       },{
            "StreamName":"stream001",
            "Domain":"example.com",
            "Bandwidth":12,
            "Protocol":"Flv",
            "Request":10,
            "OnlineUser":20
     }],
     "RequestId": "k54e3deb-f318-****-8a68-3c959642f9ec"
  }
}

错误码

您可访问公共错误码，获取更多错误码信息。