DescribeLiveBatchStreamSessionData - 查询域名下所有直播流的拉流数据--视频直播-火山引擎

文档中心

立即注册

导航

DescribeLiveBatchStreamSessionData - 查询域名下所有直播流的拉流数据

最近更新时间：2025.04.22 19:10:55首次发布时间：2024.06.27 16:56:32

调用 DescribeLiveBatchStreamSessionData 接口，查询指定时间范围内域名下所有直播流的请求数和最大在线人数。

注意事项

使用限制：支持查询指定直播域名（包含已删除域名）下的请求数和最大在线人数。
请求频率：单用户请求频率限制为 30 次/秒。
数据延迟：数据延迟为 5 分钟。

请求说明

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

调试

API Explorer

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

去调试

请求参数

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

Query

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

Body

参数	类型	是否必选	示例值	描述
DomainList	Array of String	否	`["example.com", "example2.com"]`	拉流域名列表，默认为空，表示查询所有域名的请求数和在线人数。您可以调用 ListDomainDetail 接口或在视频直播控制台的域名管理页面，获取待查询的拉流域名。
ProtocolList	Array of String	否	`["RTMP"]`	推拉流协议，缺省情况下表示所有协议类型，支持的协议如下所示。 `HTTP-FLV`：基于 HTTP 协议的推拉流协议，使用 FLV 格式传输视频格式。 `HTTP-HLS`：基于 HTTP 协议的推拉流协议，使用 TS 格式传输视频格式。 `RTMP`：Real Time Message Protocol，实时信息传输协议。 `RTM`：Real Time Media，超低延时直播协议。 `SRT`：Secure Reliable Transport，安全可靠传输协议。 `QUIC`：Quick UDP Internet Connections，一种基于 UDP 的全新的低延时互联网传输协议。说明如果查询推拉流协议为 QUIC，不能同时查询其他协议。缺省情况下，查询的总流量数据为实际产生的上下行流量。如果传入单个协议进行查询，并对各协议的流量求和，结果将大于实际总流量。
ISPList	Array of String	否	`["telecom"]`	提供网络接入服务的运营商标识符，缺省情况下表示所有运营商，支持的运营商如下所示。 `unicom`：联通； `railcom`：铁通； `telecom`：电信； `mobile`：移动； `cernet`：教育网； `tianwei`：天威； `alibaba`：阿里巴巴； `tencent`：腾讯； `drpeng`：鹏博士； `btvn`：广电； `huashu`：华数。您也可以通过 DescribeLiveISPData 接口获取运营商对应的标识符。
RegionList	Array of RegionList	否	`-`	CDN 节点 IP 所属区域的列表，缺省情况下表示所有区域。
StartTime	String	是	`2021-04-13T00:00:00+08:00`	查询的开始时间，RFC3339 格式的时间戳，精度为秒。说明单次查询最大时间跨度为 24 小时，查询历史数据的时间范围为 366 天。
EndTime	String	是	`2021-04-14T00:00:00+08:00`	查询的结束时间，RFC3339 格式的时间戳，精度为秒。
PageNum	Integer	否	`1`	查询数据的页码，默认值为 1，表示查询第一页的数据。
PageSize	Integer	否	`100`	每页显示的数据条数，默认值为 1000，取值范围为 [100,1000]。
OnlineUserType	String	否	`Viewer`	在线人数统计方式，取值及含义如下所示： `Online`：以 1 分钟瞬时连接的 session 数作为 1 分钟粒度的在线人数数量； `Viewer`（默认值）：以 1 分钟内的 session 链接总数作为 1 分钟粒度的在线人数数量。

RegionList

参数	类型	是否必选	示例值	描述
Area	String	否	`CN`	区域信息中的大区标识符，如何获取请参见查询区域标识符。
Country	String	否	`CN`	区域信息中的国家标识符，如何获取请参见查询区域标识符。如果按国家筛选，需要同时传入 `Area` 和 `Country`。
Province	String	否	`beijing`	区域信息中的省份标识符，国外暂不支持该参数，如何获取请参见查询区域标识符。如果按省筛选，需要同时传入 `Area`、`Country` 和 `Province`。

返回参数

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

参数	类型	示例值	描述
DomainList	Array of String	`["example.com", "example2.com"]`	域名列表。
ProtocolList	Array of String	`["RTMP"]`	推拉流协议，协议说明如下。 `HTTP-FLV`：基于 HTTP 协议的推拉流协议，使用 FLV 格式传输视频格式。 `HTTP-HLS`：基于 HTTP 协议的推拉流协议，使用 TS 格式传输视频格式。 `RTMP`：Real Time Message Protocol，实时信息传输协议。 `RTM`：Real Time Media，超低延时直播协议。 `SRT`：Secure Reliable Transport，安全可靠传输协议。 `QUIC`：Quick UDP Internet Connections，一种基于 UDP 的全新的低延时互联网传输协议。
ISPList	Array of String	`["telecom"]`	提供网络接入服务的运营商标识符，标识符与运营商的对应关系如下。 `unicom`：联通； `railcom`：铁通； `telecom`：电信； `mobile`：移动； `cernet`：教育网； `tianwei`：天威； `alibaba`：阿里巴巴； `tencent`：腾讯； `drpeng`：鹏博士； `btvn`：广电； `huashu`：华数。
RegionList	Array of RegionList	`-`	CDN 节点 IP 所属区域列表。
StartTime	String	`2022-11-10T00:00:00+08:00`	查询的开始时间，RFC3339 格式的时间戳，精度为秒。
EndTime	String	`2022-11-11T00:00:00+08:00`	查询的结束时间，RFC3339 格式的时间戳，精度为秒。
TotalRequest	Integer	`20`	查询时间范围内的请求数总数。
PeakOnlineUser	Integer	`20`	查询时间范围内的在线人数峰值。
StreamInfoList	Array of StreamInfoList	`-`	查询时间范围内所有流的请求数和在线人数峰值信息。
Pagination	Object of Pagination	`-`	数据分页的信息。

RegionList

参数	类型	示例值	描述
Area	String	`CN`	区域信息中的大区标识符。
Country	String	`CN`	区域信息中的国家标识符。
Province	String	`beijing`	区域信息中的省份标识符。

StreamInfoList

参数	类型	示例值	描述
Domain	String	`example.com`	拉流域名。
App	String	`example_app`	应用名称。
Stream	String	`example_stream`	流名称。
TotalRequest	Integer	`20`	当前流的请求数。
PeakOnlineUser	Integer	`20`	当前流的在线人数峰值

Pagination

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

请求示例

POST https://live.volcengineapi.com?Action=DescribeLiveBatchStreamSessionData&Version=2023-01-01
{
    "DomainList": [
        "pull.example.com"
    ],
    "StartTime": "2024-06-21T00:00:00+08:00",
    "EndTime": "2024-06-22T00:00:00+08:00",
    "PageNum": 1,
    "PageSize": 100
    ]
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20240627161132A06E6F00FDE6B662DC03",
        "Action": "DescribeLiveBatchStreamSessionData",
        "Version": "2023-01-01",
        "Service": "live",
        "Region": "cn-north-1"
    },
    "Result": {
        "StartTime": "2024-06-21T00:00:00+08:00",
        "EndTime": "2024-06-22T00:00:00+08:00",
        "TotalRequest": 10,
        "PeakOnlineUser": 1,
        "Pagination": {
            "PageNum": 1,
            "PageSize": 100,
            "TotalCount": 2
        },
        "StreamInfoList": [
            {
                "Domain": "pull.example.com",
                "Stream": "568916007549913427",
                "App": "live",
                "TotalRequest": 3,
                "PeakOnlineUser": 0
            },
            {
                "Domain": "pull.example.com",
                "Stream": "568957930212847406",
                "App": "live",
                "TotalRequest": 7,
                "PeakOnlineUser": 1
            }
        ]
    }
}

错误码

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

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

服务端 SDK

视频直播提供了配套的开发工具集 SDK，支持多种编程语言，帮助您更方便的调用 API。