You need to enable JavaScript to run this app.
导航
DescribeLiveStreamUsageData - 查询指定时间流和协议维度的数据
最近更新时间:2025.04.22 19:10:55首次发布时间:2023.10.24 19:58:33
我的收藏
有用
有用
无用
无用

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

注意事项

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

请求说明

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

请求参数

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

Query

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

Body

参数类型是否必选示例值描述
DomainStringexample.com域名。
StreamNameStringstream001流名称。

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 展示失败的原因
ResponseObject of Response-响应数据。

Response

参数类型示例值描述
QueryTimeString2022-04-13 10:00查询时间。
RequestIdStringk54e3deb-f318-****-8a68-3c959642f9ec请求 ID。
DataInfoListArray of DataInfoList-详细数据信息。

DataInfoList

参数类型示例值描述
BandwidthInteger20带宽,单位 kbps。
ProtocolStringP2p协议。
RequestInteger10请求数。
OnlineUserInteger10在线人数。
DomainStringexample.com域名
StreamNameStringtest流名称。

请求示例

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"
    }
}

错误码

下表仅列出本接口特有的错误码。更多信息请参见公共错误码获取详细信息。

状态码错误码错误信息说明
400InvalidParam-输入的参数无效或不符合要求,请参照请求参数说明进行检查。
403RequestForbidden-请求被拒绝,当前账号下无请求的资源(域名空间、域名、应用、配置模版、证书)。
500InternalErroran internal error occurred, please contact the administrator.出现内部错误,请联系技术支持