调用 DescribeLiveTopPlayData 接口，查询指定时间范围内 TOPN 直播流或 TOPN 域名的流量和带宽信息。

注意事项

• 请求频率：单用户请求频率限制为 30 次/秒。
• 数据延迟：当日 07:00 可查询前一日数据。
• 数据进制：
  • 带宽数据统计进制为 1000，例如，1 Mbps = 1000 Kbps。
  • 流量数据统计进制为 1000，例如，1 GB = 1000 MB。

请求说明

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

调试

请求参数

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

Query

Body

返回参数

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

DataItemList

Pagination

请求示例

POST https://live.volcengineapi.com?Action=DescribeLiveTopPlayData&Version=2023-01-01
{
    "StartTime": "2024-11-16T00:00:00+08:00",
    "EndTime": "2024-11-20T00:00:00+08:00",
    "QueryType": "Stream",
    "SortBy": "PeakBandwidth",
    "VhostList": [
        "push.example.com"
    ],
    "DomainList": [
        "push.example.com"
    ],
    "PageSize": "10",
    "PageNum": "1"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "DescribeLiveTopPlayData",
        "Version": "2023-01-01",
        "Service": "live",
        "Region": "cn-north-1"
    },
    "Result": {
        "StartTime": "2024-11-16T00:00:00+08:00",
        "EndTime": "2024-11-20T00:00:00+08:00",
        "QueryType": "Stream",
        "SortBy": "PeakBandwidth",
        "VhostList": [
            "push.example.com"
        ],
        "DomainList": [
            "push.example.com"
        ],
        "DataItemList": [
            {
                "Domain": "push.example.com",
                "App": "live",
                "Stream": "example_stream",
                "PeakBandwidth": 1000,
                "AvgBandwidth": 1000,
                "TotalTraffic": 20000
            }
        ],
        "Pagination": {
            "PageSize": "10",
            "PageNum": "1",
            "TotalCount": "20"
        }
    }
}

错误码

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