DescribeLiveStreamCountData - 查询峰值流数--视频直播-火山引擎

文档中心

立即注册

导航

DescribeLiveStreamCountData - 查询峰值流数

最近更新时间：2024.12.18 16:31:43首次发布时间：2023.09.25 14:36:18

调用 DescribeLiveStreamCountData 接口，查询时间范围内指定推流、回源流或转码流的峰值数量。

注意事项

请求频率：单用户请求频率限制为 30 次/秒。
数据延迟：数据延迟为 5 分钟。

请求说明

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

调试

API Explorer

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

去调试

请求参数

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

Query

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

Body

参数	类型	是否必选	示例值	描述
DomainList	Array of String	否	`["push.exmaple.com","push2.example.com"]`	直播流使用的域名列表，默认为空，表示查询所有全部域名下的峰值流数。您可以调用 ListDomainDetail 接口或在视频直播控制台的域名管理页面，查看直播流使用的域名。
StreamType	Array of String	否	`["push"]`	流类型，缺省情况下表示全部类型，支持的流类型取值如下。 `push`：推流； `relay-source`：回源流； `transcode`：转码流。
ISPList	Array of String	否	`["telecom"]`	提供网络接入服务的运营商标识符，缺省情况下表示所有运营商，支持的运营商如下所示。 `unicom`：联通； `railcom`：铁通； `telecom`：电信； `mobile`：移动； `cernet`：教育网； `tianwei`：天威； `alibaba`：阿里巴巴； `tencent`：腾讯； `drpeng`：鹏博士； `btvn`：广电； `huashu`：华数。说明当流类型 `StreamType` 为推流 `push` 时支持使用运营商对查询数据进行筛选。您也可以通过 DescribeLiveISPData 接口获取运营商对应的标识符。
UserRegionList	Array of UserRegionList	否	`-`	客户端 IP 所属区域的列表，缺省情况下表示所有区域。说明当流类型 `StreamType` 为推流 `push` 时支持使用客户端 IP 所属的区域对查询数据进行筛选。
Aggregation	Integer	否	`60`	聚合的时间粒度，单位为秒，支持的时间粒度如下所示。 `60`：1 分钟； `300`：（默认值）5 分钟； `3600`：1 小时。
DetailField	Array of String	否	`["Domain"]`	数据拆分的维度，默认为空表示不按维度进行数据拆分，支持的维度如下所示。 `Domain`：域名； `ISP`：运营商。
StartTime	String	是	`2021-08-16T00:00:00+08:00`	查询的开始时间，RFC3339 格式的时间戳，精度为秒。说明历史查询最大时间范围为 366 天，单次查询最大时间跨度与数据拆分维度和数据聚合时间粒度有关，详细如下。当不进行维度拆分或只使用一个维度拆分数据时：数据以 60 秒聚合时，单次查询最大时间跨度为 24 小时；数据以 300 秒聚合时，单次查询最大时间跨度为 31 天；数据以 3600 秒聚合时，单次查询最大时间跨度为 31 天。当使用两个或两个以上维度拆分数据时：数据以 60 秒聚合时，单次查询最大时间跨度为 3 小时；数据以 300 秒聚合时，单次查询最大时间跨度为 24 小时；数据以 3600 秒聚合时，单次查询最大时间跨度为 7 天。
EndTime	String	是	`2021-08-16T00:01:59+08:00`	查询的结束时间，RFC3339 格式的时间戳，精度为秒。

UserRegionList

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

返回参数

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

参数	类型	示例值	描述
DomainList	Array of String	`["push.example.com","push2.example.com"]`	域名列表。
StartTime	String	`2021-08-16T00:00:00+08:00`	查询的开始时间，RFC3339 格式的时间戳，精度为秒。
EndTime	String	`2021-08-16T00:01:59+08:00`	查询的结束时间，RFC3339 格式的时间戳，精度为秒。
Aggregation	Integer	`60`	数据聚合的时间粒度，单位为秒。 `60`：1 分钟； `300`：5 分钟； `3600`：1 小时。
DetailField	Array of String	`["Domain"]`	数据拆分的维度，当前接口仅支持按 `Domain` 即域名维度进行数据拆分。
StreamType	Array of String	`["push"]`	流类型，流类型说明如下。 `push`：拉流； `relay-source`：回源流； `transcode`：转码流。
PeakCount	Integer	`100`	当前查询条件下流数最大值。
TotalStreamDataList	Array of TotalStreamDataList	`-`	所有时间粒度的数据。
StreamDetailDataList	Array of StreamDetailDataList	`-`	按维度拆分后的数据。
ISPList	Array of String		ISP 列表。
UserRegionList	Array of UserRegionList		用户区域列表。

TotalStreamDataList

参数	类型	示例值	描述
TimeStamp	String	`2021-08-16T00:00:00+08:00`	数据按时间粒度聚合时，每个时间粒度的开始时间，RFC3339 格式的时间戳，精度为秒。
PeakCount	Integer	`100`	当前数据聚合时间粒度内的流数最大值。

StreamDetailDataList

参数	类型	示例值	描述
Domain	String	`push.example.com`	按域名维度进行数据拆分时的域名信息。
TotalStreamDataList	Array of TotalStreamDataList	`-`	按维度进行数据拆分后，当前维度下的所有时间粒度数据。

UserRegionList

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

请求示例

POST https://live.volcengineapi.com?Action=DescribeLiveStreamCountData&Version=2023-01-01
{
  "DomainList": [
    "push.example.com",
    "push2.example.com"
  ],
  "StartTime": "2021-08-16T00:00:00+08:00",
  "EndTime": "2021-08-16T00:01:59+08:00",
  "Aggregation": 60,
  "DetailField": [
    "Domain"
  ],
  "StreamType": [
    "pull",
    "relay-source"
  ]
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "201806041104200100100232280022D30",
    "Action": "DescribeLiveSourceStreamCountData",
    "Version": "2023-01-01",
    "Service": "live",
    "Region": "cn-north-1"
  },
  "Result": {
    "DomainList": [
      "push.example.com",
      "push2.example.com"
    ],
    "StartTime": "2021-08-16T00:00:00+08:00",
    "EndTime": "2021-08-16T00:01:59+08:00",
    "Aggregation": 60,
    "DetailField": [
      "Domain"
    ],
    "StreamType": [
      "pull",
      "relay-source"
    ],
    "PeakCount": 100,
    "TotalStreamDataList": [
      {
        "TimeStamp": "2021-08-16T00:00:00+08:00",
        "PeakCount": 100
      }
    ],
    "StreamDetailDataList": [
      {
        "Domain": "push.example.com",
        "TotalStreamDataList": [
          {
            "TimeStamp": "2021-08-16T00:00:00+08:00",
            "PeakCount": 100
          }
        ]
      },
      {
        "Domain": "push2.example.com",
        "TotalStreamDataList": [
          {
            "TimeStamp": "2021-08-16T00:00:00+08:00",
            "PeakCount": 100
          }
        ]
      }
    ]
  }
}

错误码

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

状态码	错误码	错误信息	说明
200	CommonErr	-	未分类错误。建议重试，如果仍返回该错误码，请联系技术支持。
400	InvalidParam	-	输入的参数无效或不符合要求，请参照请求参数说明进行检查。
400	InvalidParam.BindError	Request parameter error, please check input data	参数未通过校验，请检查参数类型是否正确。
403	RequestForbidden	-	请求被拒绝，当前账号下无请求的资源（域名空间、域名、应用、配置模版、证书）。
403	RequestForbidden.AccountIDNotAllow	this AccountID does not have permission to access the corresponding resource, please check the request parameters	请求被拒绝，当前账号下无请求的资源（域名空间、域名、应用、配置模版、证书）。
403	RequestForbidden.BillingStatus	Billing status is not available for the AccountID, please activate the service or recharge.	未开通视频直播服务或账号欠费，造成账单不可用，请检查服务开通情况和账号欠费情况。
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。