You need to enable JavaScript to run this app.
最新活动
产品
解决方案
定价
生态与合作
支持与服务
开发者
了解我们
导航
视频直播
  • 文档首页
    • /
  • 视频直播

查询直播流请求数和在线人数

最近更新时间：2023.08.07 11:52:35

首次发布时间：2021.11.23 15:56:02

我的收藏

支持查询一定时间范围内的直播拉流的在线人数和拉流请求数，支持按拉流协议区分。支持查询删除域名的直播流请求数和在线人数。

注意事项

  • 请求频率：单用户请求频率限制为 100 次/秒。
  • 数据延迟：数据延迟为 3min。

请求说明

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

请求参数

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

Query

参数类型是否必选示例值描述
ActionString是DescribeLiveStreamSessionData接口名称。当前 API 的名称为 DescribeLiveStreamSessionData。
VersionString是2020-08-01接口版本。当前 API 的版本为 2020-08-01。

Body

参数类型是否必选示例值描述

DomainList

Array of String

否

["example.com"]

域名列表。缺省情况表示该用户的所有域名。

说明

DomainList 和 Domain 传且仅传一个。

Domain

String

否

example.com

查询流粒度数据时的域名参数，支持推流域名和拉流域名。

使用 Domain 构造请求时，需要同时定义 App 和 Stream 参数，不可缺省。

App

String

否

example_app

查询流粒度数据时的应用名参数。

使用 App 构造请求时，需要同时定义 Domain 和 Stream 参数，不可缺省。

Stream

String

否

example_stream

查询流粒度数据时的流名称参数。

使用 Stream 构造请求时，需要同时定义 Domain 和 App 参数，不可缺省。

RefererListArray of String否["www.test.com"]请求的 Referer

ProtocolList

Array of String

否

["HTTP-FLV", "RTMP"]

推拉流协议，缺省情况下表示所有协议类型。支持的协议如下所示。

  • HTTP-FLV
  • HTTP-HLS
  • RTMP
  • RTM
  • SRT
  • QUIC

说明

如果设置推拉流协议为 QUIC，不能同时传其他协议。

ISPList

Array of String

否

["telecom"]

运营商，缺省情况下表示所有运营商。支持的运营商如下所示。

  • telecom：中国电信；
  • unicom：中国联通；
  • mobile：中国移动；
  • btvn：广电网；
  • huashu：华数；
  • drpeng：鹏博士。
RegionListArray of RegionList否-区域列表，缺省情况表示所有区域。
StartTimeString是2021-04-13T00:00:00+08:00查询的起始时间，RFC3339 格式的 UTC 时间，精度为 s，例如，2022-04-01T00:00:00+08:00
EndTimeString是2021-04-14T00:00:00+08:00查询的结束时间，RFC3339 格式的 UTC 时间，精度为 s，例如，2022-04-02T00:00:00+08:00

Aggregation

Integer

否

003

聚合的时间粒度，单位为 s，默认值为 300。支持如下时间粒度。

  • 60：支持单次查询时间跨度为 24 小时，历史查询时间范围为 7 天；
  • 300：支持单次查询时间跨度为 31 天，历史查询时间范围为 93 天；
  • 3600：支持单次查询时间跨度为 93 天，历史查询时间范围为 93 天。

ShowDetail

Boolean

否

true

是否返回过滤字段和时间聚合后的数据，默认为 false。

  • true：返回；
  • false：不返回。

RegionList

参数类型是否必选示例值描述
AreaString否CN大区，映射关系请参见区域映射
CountryString否CN国家，映射关系请参见区域映射。如果按国家筛选，需要同时传入 Area 和 Country。
ProvinceString否beijing国内为省，国外暂不支持该参数，映射关系请参见区域映射。如果按省筛选，需要同时传入 Area、Country 和 Province。

返回参数

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

参数类型示例值描述
DomainListArray of String["example.com"]域名列表
DomainStringexample.com域名
AppStringexample_app应用名称
StreamStringexample_stream直播流名称
RefererListArray of String["www.test.com"]请求的 Referer
ProtocolListArray of String["HTTP-FLV", "RTMP"]推拉流协议
ISPListArray of String["telecom"]运营商
RegionListArray of RegionList-区域
StartTimeString2021-04-13T00:00:00+08:00起始时间
EndTimeString2021-04-14T00:00:00+08:00结束时间
AggregationInteger300时间粒度
TotalRequestInteger20总的请求数
PeakOnlineUserInteger20在线人数峰值
SessionDataListArray of SessionDataList-查询范围内的汇总信息

SessionDetailDataList

Array of SessionDetailDataList

-

按照搜索过滤字段和时间粒度聚合的数据

说明

请求时，DomainList、RefererList、ProtocolList 和 ISPList 至少有一个参数传入了多个值时，会返回该参数；否则不返回该参数。

RegionList

参数类型示例值描述
AreaStringCN大区，映射关系请参见区域映射
CountryStringCN国家，映射关系请参见区域映射
ProvinceStringbeijing国内为省，国外暂不支持该参数，映射关系请参见区域映射

SessionDataList

参数类型示例值描述
TimestampString2022-04-13T00:00:00+08:00时间片起始时刻。RFC3339 时间，例如，2022-04-13T00:00:00+08:00
RequestInteger10请求数
OnlineUserInteger20在线人数

SessionDetailDataList

参数类型示例值描述
DomainStringexample.com域名
RefererStringwww.test.com请求的 Referer
ProtocolStringHTTP-FLV推拉流协议
ISPStringtelecom运营商
TotalRequestInteger20总的请求数
PeakOnlineUserInteger20在线人数峰值
SessionDataListArray of SessionDataList-按时间粒度聚合的数据

示例

请求示例

POST https://live.volcengineapi.com?Action=DescribeLiveStreamSessionData&Version=2020-08-01
{
    "DomainList": ["example.com"],
    "ProtocolList": ["HTTP-FLV", "RTMP"],
    "ISPList": ["telecom"],
    "RefererList": ["www.test.com"],
    "RegionList": [
        {
            "Area": "CN",
            "Country": "CN",
            "Province": "beijing",
        }
    ],
    "StartTime": "2021-04-13T00:00:00+08:00",
    "EndTime": "2021-04-14T00:00:00+08:00",
    "Aggregation": 300,
    "ShowDetail": true
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "201806041104200100100232280022D30",
    "Action": "DescribeLiveStreamSessionData",
    "Version": "2020-08-01",
    "Service": "live",
    "Region": "cn-north-1"
  },
  "Result": {
    "DomainList": [
      "example.com"
    ],
    "ProtocolList": [
      "HTTP-FLV",
      "RTMP"
    ],
    "ISPList": [
      "telecom"
    ],
    "RefererList": [
      "www.test.com"
    ],
    "RegionList": [
      {
        "Area": "CN",
        "Country": "CN",
        "Province": "beijing"
      }
    ],
    "StartTime": "2021-04-13T00:00:00+08:00",
    "EndTime": "2021-04-14T00:00:00+08:00",
    "Aggregation": 300,
    "TotalRequest": 20,
    "PeakOnlineUser": 20,
    "SessionDataList": [
      {
        "TimeStamp": "2022-04-13T00:00:00+08:00",
        "Request": 10,
        "OnlineUser": 20
      },
      {
        "TimeStamp": "2022-04-13T00:05:00+08:00",
        "Request": 10,
        "OnlineUser": 20
      }
    ],
    "SessionDetailDataList": [
      {
        "Protocol": "HTTP-FLV",
        "TotalRequest": 20,
        "PeakOnlineUser": 20,
        "SessionDataList": [
          {
            "TimeStamp": "2022-04-13T00:00:00+08:00",
            "Request": 20,
            "OnlineUser": 20
          },
          {
            "TimeStamp": "2022-04-13T00:05:00+08:00",
            "Request": 20,
            "OnlineUser": 20
          }
        ]
      },
      {
        "Protocol": "RTMP",
        "TotalRequest": 0,
        "PeakOnlineUser": 0,
        "SessionDataList": [
          {
            "TimeStamp": "2022-04-13T00:00:00+08:00",
            "Request": 0,
            "OnlineUser": 0
          },
          {
            "TimeStamp": "2022-04-13T00:05:00+08:00",
            "Request": 0,
            "OnlineUser": 0
          }
        ]
      }
    ]
  }
}

错误码

访问公共错误码获取详细信息。