查询域名或单个直播流的拉流数据--视频直播-火山引擎

文档中心

立即注册

导航

查询域名或单个直播流的拉流数据

最近更新时间：2024.09.27 15:29:27首次发布时间：2023.09.25 14:36:18

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

注意事项

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

请求说明

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

调试

API Explorer

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

去调试

请求参数

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

Query

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

Body

参数	类型	是否必选	示例值	描述
DomainList	Array of String	否	`["pull.example.com"]`	拉流域名列表，默认为空，表示查询所有域名的请求数和在线人数。您可以调用 ListDomainDetail 接口或在视频直播控制台的域名管理页面，获取待查询的拉流域名。说明 `DomainList` 和 `Domain` 传且仅传一个。
Domain	String	否	`pull.example.com`	拉流域名，您可以调用 ListDomainDetail 接口或在视频直播控制台的域名管理页面，获取待查询的拉流域名。说明查询流粒度的请求数和在线人数数据时，需同时指定 `Domain` 、`App` 和 `Stream` 来指定直播流。
App	String	否	`live`	应用名称，取值需与直播流地址中 `AppName` 相同，支持由大小写字母（A - Z、a - z）、数字（0 - 9）、下划线（_）、短横线（-）和句点（.）组成，长度为 1 到 30 个字符。说明查询流粒度的请求数和在线人数数据时，需同时指定 `Domain` 、`App` 和 `Stream` 来指定直播流。
Stream	String	否	`example_stream`	流名称，取值需与直播流地址中的 `StreamName` 相同，支持由大小写字母（A - Z、a - z）、数字（0 - 9）、下划线（_）、短横线（-）和句点（.）组成，长度为 1 到 100 个字符。说明查询流粒度的请求数和在线人数数据时，需同时指定 `Domain` 、`App` 和 `Stream` 来指定直播流。
RefererList	Array of String	否	`["www.test.com"]`	指定拉流请求的 Referer 信息，默认为空，表示不对拉流请求的 Referer 字段进行校验。
ProtocolList	Array of String	否	`["HTTP-FLV", "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"]`	提供网络接入服务的运营商标识符，缺省情况下表示所有运营商，支持的运营商如下所示。 `unicom`：联通； `railcom`：铁通； `telecom`：电信； `mobile`：移动； `cernet`：教育网； `tianwei`：天威； `alibaba`：阿里巴巴； `tencent`：腾讯； `drpeng`：鹏博士； `btvn`：广电； `huashu`：华数； `other`：其他。您也可以通过 DescribeLiveISPData 接口获取运营商对应的标识符。
RegionList	Array of Region	否	`-`	CDN 节点 IP 所属区域的列表，缺省情况下表示所有区域。
StartTime	String	是	`2021-04-13T00:00:00+08:00`	查询的开始时间，RFC3339 格式的时间戳，精度为秒。
EndTime	String	是	`2021-04-14T00:00:00+08:00`	查询的结束时间，RFC3339 格式的时间戳，精度为秒。
Aggregation	Integer	否	`300`	数据聚合的时间粒度，单位为秒，支持的时间粒度如下所示。 `60`：1 分钟。时间粒度为 1 分钟时，单次查询最大时间跨度为 24 小时，历史查询时间范围为 366 天； `300`：（默认值）5 分钟。时间粒度为 5 分钟时，单次查询最大时间跨度为 31 天，历史查询时间范围为 366 天； `3600`：1 小时。时间粒度为 1 小时时，单次查询最大时间跨度为 93 天，历史查询时间范围为 366 天。
DetailField	Array of String	否	`["Domain"]`	数据拆分的维度，默认为空表示不按维度进行数据拆分，支持的维度如下所示。 `Domain`：域名； `ISP`：运营商； `Protocol`：推拉流协议； `Referer`：请求的 Referer 信息。说明配置数据拆分的维度时，对应的维度参数传入多个值时才会返回按此维度拆分的数据。例如，配置按 Domain 进行数据拆分时， DomainList 传入多个 Domain 值时，才会返回按 Domain 拆分的数据。
OnlineUserType	String	否	`Online`	在线人数统计方式，取值及含义如下所示： `Online`（默认值）：以 1 分钟瞬时连接的 session 数作为 1 分钟粒度的在线人数数量； `Viewer`：以 1 分钟内的 session 链接总数作为 1 分钟粒度的在线人数数量。

Region

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

返回参数

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

参数	类型	示例值	描述
DomainList	Array of String	`["push.example.com"]`	域名列表。
Domain	String	`pull.example.com`	拉流域名。
App	String	`live`	应用名称。
Stream	String	`example_stream`	流名称。
RefererList	Array of String	`["www.test.com"]`	拉流请求的 Referer 信息。
ProtocolList	Array of String	`["HTTP-FLV", "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 的全新的低延时互联网传输协议。byteplus比火山多了CMAF协议
ISPList	Array of String	`["telecom", "unicom"]`	提供网络接入服务的运营商标识符，标识符与运营商的对应关系如下。 `unicom`：联通； `railcom`：铁通； `telecom`：电信； `mobile`：移动； `cernet`：教育网； `tianwei`：天威； `alibaba`：阿里巴巴； `tencent`：腾讯； `drpeng`：鹏博士； `btvn`：广电； `huashu`：华数； `other`：其他。
RegionList	Array of Region	`-`	CDN 节点 IP 所属区域列表。
StartTime	String	`2021-04-13T00:00:00+08:00`	查询的开始时间，RFC3339 格式的时间戳，精度为秒。
EndTime	String	`2021-04-14T00:00:00+08:00`	查询的结束时间，RFC3339 格式的时间戳，精度为秒。
Aggregation	Integer	`300`	数据聚合的时间粒度，单位为秒。
DetailField	Array of String	`["Domain"]`	数据拆分的维度，维度说明如下所示。 `Domain`：域名； `ISP`：运营商； `Protocol`：推拉流协议； `Referer`：请求的 Referer 信息。
TotalRequest	Integer	`20`	查询时间范围内的请求数。
PeakOnlineUser	Integer	`20`	查询时间范围内的在线人数峰值。
SessionDataList	Array of SessionDataList	`-`	所有时间粒度的数据。
SessionDetailDataList	Array of SessionDetailDataList	`-`	按维度拆分的数据。

Region

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

SessionDataList

参数	类型	示例值	描述
TimeStamp	String	`2022-04-13T00:00:00+08:00`	数据按时间粒度聚合时，每个时间粒度的开始时间，RFC3339 格式的时间戳，精度为秒。
Request	Integer	`10`	当前数据聚合时间粒度内的请求数。
OnlineUser	Integer	`20`	当前数据聚合时间粒度内的在线人数最大值。

SessionDetailDataList

参数	类型	示例值	描述
Domain	String	`pull.example.com`	按域名维度进行数据拆分时的域名信息。
Referer	String	`www.test.com`	按请求的 Referer 信息进行数据拆分时的 Referer 信息。
Protocol	String	`HTTP-FLV`	按推拉流协议维度进行数据拆分时的协议信息。
ISP	String	`telecom`	按运营商维度进行数据拆分时的运营商信息。
TotalRequest	Integer	`20`	按维度进行数据拆分后，当前维度的请求数。
PeakOnlineUser	Integer	`20`	按维度进行数据拆分后，当前维度的在线人数峰值。
SessionDataList	Array of SessionDataList	`-`	按维度进行数据拆分后，当前维度下所有时间粒度的数据。

请求示例

POST https://live.volcengineapi.com?Action=DescribeLiveStreamSessionData&Version=2023-01-01
{
  "DomainList": [
    "push.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": [
      "push.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
          }
        ]
      }
    ]
  }
}

错误码

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

状态码	错误码	错误信息	说明
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.	内部服务超时，请联系技术支持。

服务端 SDK

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