You need to enable JavaScript to run this app.
导航

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

最近更新时间2023.10.23 16:15:04

首次发布时间2023.09.25 14:36:18

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

注意事项

  • 请求频率:单用户请求频率限制为 100 次/秒
  • 数据延迟:时间粒度为 60 秒时,数据延迟为 5 分钟;其他时间粒度时,数据延迟为 15 分钟

请求说明

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

请求参数

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

Query

参数类型是否必选示例值描述
ActionStringDescribeLiveStreamSessionData接口名称。当前 API 的名称为 DescribeLiveStreamSessionData
VersionString2023-01-01接口版本。当前 API 的版本为 2023-01-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"]

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

  • unicom:联通;
  • railcom:铁通;
  • telecom:电信;
  • mobile:移动;
  • cernet:教育网;
  • tianwei:天威;
  • alibaba:阿里巴巴;
  • tencent:腾讯;
  • drpeng:鹏博士;
  • btvn:广电;
  • huashu:华数;
  • other:其他。
RegionListArray of RegionList-区域列表,缺省情况表示所有区域。
StartTimeString2021-04-13T00:00:00+08:00查询的起始时间,RFC3339 格式的 UTC 时间,精度为 s。
EndTimeString2021-04-14T00:00:00+08:00查询的结束时间,RFC3339 格式的 UTC 时间,精度为 s。

Aggregation

Integer

003

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

  • 60:支持单次查询时间跨度为 24 小时,历史查询时间范围为 7 天;
  • 300:支持单次查询时间跨度为 31 天,历史查询时间范围为 93 天;
  • 3600:支持单次查询时间跨度为 93 天,历史查询时间范围为 93 天。
DetailFieldArray of String数据拆分的维度,可取值为 "Domain","ISP","Protocol","Referer",设置为空时不进行数据拆分。

RegionList

参数类型是否必选示例值描述
AreaStringCN大区标识符,如何获取请参见查询区域标识符
CountryStringCN国家标识符,如何获取请参见查询区域标识符。如果按国家筛选,需要同时传入 Area 和 Country
ProvinceStringbeijing省份标识符,国外暂不支持该参数,如何获取请参见查询区域标识符。如果按省筛选,需要同时传入 AreaCountry 和 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 RegionListResponse-区域。
StartTimeString2021-04-13T00:00:00+08:00开始时间。
EndTimeString2021-04-14T00:00:00+08:00结束时间。
AggregationInteger300时间粒度。
DetailFieldArray of String["Domain"]数据拆分的维度。
TotalRequestInteger20总的请求数。
PeakOnlineUserInteger20在线人数峰值。
SessionDataListArray of SessionDataList-查询范围内的汇总信息。

SessionDetailDataList

Array of SessionDetailDataList

-

按维度拆分后的详细数据。

说明

请求时,DomainListRefererListProtocolList 和 ISPList 至少有一个参数传入了多个值时,会返回该参数;否则不返回该参数。

RegionListResponse

参数类型示例值描述
AreaStringCN大区标识符,如何获取请参见查询区域标识符
CountryStringCN国家标识符,如何获取请参见查询区域标识符。如果按国家筛选,需要同时传入 Area 和 Country
ProvinceStringbeijing省份标识符,国外暂不支持该参数,如何获取请参见查询区域标识符。如果按省筛选,需要同时传入 AreaCountry 和 Province

SessionDataList

参数类型示例值描述
TimeStampString2022-04-13T00:00:00+08:00时间片开始时刻。RFC3339 时间,精度为 s。
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=2023-01-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,
  "DetailField": [
    "Protocol"
  ]
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "201806041104200100100232280022D30",
    "Action": "DescribeLiveStreamSessionData",
    "Version": "2023-01-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
          }
        ]
      }
    ]
  }
}

错误码

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

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