You need to enable JavaScript to run this app.
导航
查询直播域名流量用量
最近更新时间:2023.10.12 17:39:57首次发布时间:2021.11.22 11:40:05

查询直播上行、下行(含时移分发)流量数据。

  • 支持按照域名维度(含删除域名)查询;
  • 支持按照 5 分钟,1 小时和 1 天粒度聚合;
  • 上行总流量为 TrafficDataList Up 取和;
  • 下行总流量为 TrafficDataList Down 取和。

说明

该接口属于历史版本 API,我们计划于 2023 年 12 月 25 日停止对其进行维护,并于 2024 年 3 月 25 日下线文档,建议您使用新版查询直播域名流量用量接口。

注意事项

  • 请求频率:单用户请求频率限制为 100 次/秒
  • 数据延迟:数据延迟为 15 分钟

请求说明

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

请求参数

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

Query

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

Body

参数类型是否必选示例值描述
DomainListArray of String["example.com"]域名列表,缺省情况表示该用户的所有域名

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 Region-CDN 节点 IP 所属区域的列表。缺省情况下表示所有区域。
UserRegionListArray of Region-客户端 IP 所属区域的列表,缺省情况下表示所有区域。
StartTimeString2021-04-13T00:00:00+08:00查询的起始时间,RFC3339 格式的 UTC 时间,精度为 s,例如:2021-04-13T00:00:00+08:00
EndTimeString2021-04-14T00:00:00+08:00查询的结束时间,RFC3339 格式的 UTC 时间,精度为 s,例如:2021-04-14T00:00:00+08:00

Aggregation

Integer

300

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

  • 300:支持单次查询时间跨度为 31 天,历史查询时间范围为 93 天;
  • 3600:支持单次查询时间跨度为 93 天,历史查询时间范围为 93 天;
  • 86400:支持单次查询时间跨度为 366 天,历史查询时间范围为 366 天。

ShowDetail

Boolean

true

是否返回更详细的数据,默认为 false。

  • true:返回每个过滤字段对应的用量数据;
  • false:不返回。

Region

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

返回参数

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

参数类型示例值描述
DomainListArray of String["example.com"]域名列表,代表所查询的域名
ProtocolListArray of String["HTTP-FLV", "RTMP"]推拉流协议
ISPListArray of String["telecom"]运营商
RegionListArray of RegionResponse-CDN 节点 IP 所属区域
UserRegionListArray of RegionResponse-客户端 IP 所属区域
StartTimeString2021-04-13T00:00:00+08:00起始时间
EndTimeString2021-04-14T00:00:00+08:00结束时间
AggregationInteger300时间粒度
TotalUpTrafficFloat20上行总流量,单位为 GB
TotalDownTrafficFloat20下行总流量,单位为 GB
TrafficDataListArray of TrafficData-所有时间粒度数据

TrafficDetailDataList

Array of TrafficDetailData

-

过滤字段和时间聚合后的数据

说明

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

RegionResponse

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

TrafficData

参数类型示例值描述
TimeStampString2022-04-13T00:00:00+08:00时间片起始时刻。RFC3339 格式的 UTC 时间,精度为 s,例如,2022-04-13T00:00:00+08:00
UpTrafficFloat20上行带宽,单位为 Mbps
DownTrafficFloat20下行带宽,单位为 Mbps

TrafficDetailData

参数类型示例值描述
DomainStringexample.com域名
ProtocolStringHTTP-FLV推拉流协议
ISPStringtelecom运营商
TotalUpTrafficFloat0上行峰值,单位为 Mbps
TotalDownTrafficFloat0下行峰值,单位为 Mbps
TrafficDataListArray of TrafficData-所有时间粒度数据

示例

请求示例

POST https://live.volcengineapi.com?Action=DescribeLiveTrafficData&Version=2020-08-01
{
    "DomainList": ["example.com"],
    "ProtocolList": ["HTTP-FLV", "RTMP"],
    "ISPList": ["telecom"],
    "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": "DescribeLiveTrafficData",
    "Version": "2020-08-01",
    "Service": "live",
    "Region": "cn-north-1"
  },
  "Result": {
    "DomainList": [
      "example.com"
    ],
    "ProtocolList": [
      "HTTP-FLV",
      "RTMP"
    ],
    "ISPList": [
      "telecom"
    ],
    "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,
    "TotalUpTraffic": 20,
    "TotalDownTraffic": 20,
    "TrafficDataList": [
      {
        "TimeStamp": "2022-04-13T00:00:00+08:00",
        "UpTraffic": 20,
        "DownTraffic": 20
      },
      {
        "TimeStamp": "2022-04-13T00:05:00+08:00",
        "UpTraffic": 20,
        "DownTraffic": 20
      }
    ],
    "TrafficDetailDataList": [
      {
        "Protocol": "HTTP-FLV",
        "TotalUpTraffic": 20,
        "TotalDownTraffic": 20,
        "TrafficDataList": [
          {
            "TimeStamp": "2022-04-13T00:00:00+08:00",
            "UpTraffic": 20,
            "DownTraffic": 20
          },
          {
            "TimeStamp": "2022-04-13T00:05:00+08:00",
            "UpTraffic": 20,
            "DownTraffic": 20
          }
        ]
      },
      {
        "Protocol": "RTMP",
        "TotalUpTraffic": 0,
        "TotalDownTraffic": 0,
        "TrafficDataList": [
          {
            "TimeStamp": "2022-04-13T00:00:00+08:00",
            "UpTraffic": 0,
            "DownTraffic": 0
          },
          {
            "TimeStamp": "2022-04-13T00:05:00+08:00",
            "UpTraffic": 0,
            "DownTraffic": 0
          }
        ]
      }
    ]
  }
}

错误码

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