DescribeLiveTopPlayData - 查询 TOPN 直播流或域名的流量和带宽信息--视频直播-火山引擎

文档中心

立即注册

导航

DescribeLiveTopPlayData - 查询 TOPN 直播流或域名的流量和带宽信息

最近更新时间：2024.12.09 11:16:51首次发布时间：2024.12.09 10:49:04

调用 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

调试

API Explorer

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

去调试

请求参数

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

Query

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

Body

参数	类型	是否必选	示例值	描述
StartTime	String	是	`2024-11-16T00:00:00+08:00`	查询的开始时间，RFC3339 格式的时间戳，精度为秒。说明单次查询最大时间跨度为 31 天。历史查询时间范围是 366 天。带宽和流量数据按照整小时进行聚合。在此建议您，查询开始时间和查询结束时间应涵盖您所要查询的时间段的整点小时。
EndTime	String	是	`2024-11-20T00:00:00+08:00`	查询的结束时间，RFC3339 格式的时间戳，精度为秒。
QueryType	String	否	`Stream`	查询类型，取值及含义如下所示。 `Domain` ：查询 TOPN 域名的的流量带宽信息。 `Stream`（默认值）：查询 TOPN 直播流的流量带宽信息。
VhostList	Array of String	否	`["push.example.com"]`	域名空间列表，默认为空，表示所有域名空间。您可以调用 ListDomainDetail 接口或在视频直播控制台的域名管理页面，获取待查询的域名空间信息。
DomainList	Array of String	否	`["push.example.com"]`	域名列表，默认为空，表示所有域名。您可以调用 ListDomainDetail 接口或在视频直播控制台的域名管理页面，获取待查询的域名信息。
SortBy	String	否	`PeakBandwidth`	TOPN 结果的排序指标，取值及含义如下所示。 `PeakBandwidth`（默认值）：以峰值带宽值降序展示查询结果。 `AvgBandwidth`：以平均带宽值降序展示查询结果。 `TotalTraffic`：以流量加值降序展示查询结果。
PageSize	String	否	`10`	每页显示的数据条数，默认值为 10，取值范围为 [1,1000]。
PageNum	String	否	`1`	查询数据的页码，默认值为 1，表示查询第一页的数据。说明 PageSize 为 10，PageNum 为 1 时，表示查询 TOP 10 的数据。

返回参数

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

参数	类型	示例值	描述
StartTime	String	`2024-11-16T00:00:00+08:00`	查询的开始时间，RFC3339 格式的时间戳，精度为秒。
EndTime	String	`2024-11-20T00:00:00+08:00`	查询的结束时间，RFC3339 格式的时间戳，精度为秒。
QueryType	String	`Stream`	查询类型，取值及含义如下所示。 `Domain` ：查询 TOPN 域名的的流量带宽信息。 `Stream`（默认值）查询 TOPN 直播流的流量带宽信息。
VhostList	Array of String	`["push.example.com"]`	域名空间列表。
DomainList	Array of String	`["push.example.com"]`	域名列表。
SortBy	String	`PeakBandwidth`	TOPN 结果的排序指标，取值及含义如下所示。 `PeakBandwidth`（默认值）：以峰值带宽值降序展示查询结果。 `AvgBandwidth`：以平均带宽值降序展示查询结果。 `TotalTraffic`：以流量加值降序展示查询结果。
DataItemList	Array of DataItemList	`-`	带宽和流量详细数据。
Pagination	Object of Pagination	`-`	查询结果的分页信息。

DataItemList

参数	类型	示例值	描述
Domain	String	`push.example.com`	域名。
App	String	`live`	直播流的 AppName，查询类型为 `Stream` 时返回该信息。
Stream	String	`example_stream`	直播流的 StreamName，查询类型为 `Stream` 时返回该信息。
PeakBandwidth	Float	`1000`	查询时间范围内当前域名或直播流的峰值带宽，单位为 bps。
AvgBandwidth	Float	`1000`	查询时间范围内当前域名或直播流的平均带宽，单位为 bps。
TotalTraffic	Float	`20000`	查询时间范围内当前域名或直播流的流量加和，单位为 Byte。

Pagination

参数	类型	示例值	描述
PageSize	String	`10`	每页显示的数据条数。
PageNum	String	`1`	当前所在分页的页码。
TotalCount	String	`20`	查询结果的数据总条数。

请求示例

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

错误码

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

状态码	错误码	错误信息	说明
200	CommonErr	-	未分类错误。建议重试，如果仍返回该错误码，请联系技术支持。
400	InvalidParam	-	输入的参数无效或不符合要求，请参照请求参数说明进行检查。
400	InvalidParam.BindError	Request parameter error, please check input data	参数未通过校验，请检查参数类型是否正确。
403	RequestForbidden	-	请求被拒绝，当前账号下无请求的资源（域名空间、域名、应用、配置模版、证书）。
404	ResourceNotFound	-	未找到资源（域名空间、域名、应用、配置模版、证书）。建议重试，如果仍返回该错误码，请联系技术支持。
500	InternalError	an internal error occurred, please contact the administrator.	出现内部错误，请联系技术支持。
502	InternalServiceError	an internal error occurred, please contact the administrator.	服务间出现错误，请联系技术支持。
502	InternalServiceError.BadResponse	an internal error occurred, please contact the administrator.	服务间出现错误，请联系技术支持。
504	InternalServiceTimeout	Internal Service is timeout. please contact the administrator.	内部服务超时，请联系技术支持。