You need to enable JavaScript to run this app.
导航
查询直播流或域名的流量监控数据
最近更新时间:2023.11.01 19:36:25首次发布时间:2022.06.06 20:55:17

查询一定时间范围内的直播推/拉流或域名的流量监控数据。支持查询删除域名的流量数据。

说明

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

注意事项

  • 请求频率:单用户请求频率限制为 100 次/秒
  • 数据延迟:数据延迟为 3min
  • 使用场景:
    本接口用于数据监控,数据采集处理方式不同于计费。如需获取对账的流量用量,请使用 DescribeLiveTrafficData接口。

请求说明

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

请求参数

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

Query

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

Body

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

DomainList

Array of String

["example.com"]

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

说明

DomainListDomain 传且仅传一个。

Domain

String

example.com

查询流粒度数据时的域名参数,支持推流域名和拉流域名。
使用 Domain 构造请求时,需要同时定义 AppStream 参数,不可缺省。

App

String

example_app

查询流粒度数据时的应用名参数。
使用 App 构造请求时,需要同时定义 DomainStream 参数,不可缺省。

Stream

String

example_stream

查询流粒度数据时的流名称参数。
使用 Stream 构造请求时,需要同时定义 DomainApp 参数,不可缺省。

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 所属区域的列表,缺省情况下表示所有区域。
IPListArray of String["10.255.159.000"]查询单个或多个出口外网 IP 地址数据,第四个地址位需要改为 000。例如,实际 IP 地址为 10.255.159.10,则请求时取 10.255.159.000
StartTimeString2021-04-13T00:00:00+08:00查询的起始时间,RFC3339 格式的 UTC 时间,精度为 s,例如,2022-04-01T00:00:00+08:00
EndTimeString2021-04-14T00:00:00+08:00查询的结束时间,RFC3339 格式的 UTC 时间,精度为 s,例如,2022-04-02T00:00:00+08:00

Aggregation

Integer

300

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

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

ShowDetail

Boolean

true

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

  • true:返回;
  • false:不返回。

Region

参数类型是否必选示例值描述
AreaStringCN大区,映射关系请参见区域映射
CountryStringCN国家,映射关系请参见区域映射。如果按国家筛选,需要同时传入 AreaCountry
ProvinceStringbeijing国内为省,国外暂不支持该参数,映射关系请参见区域映射。如果按省筛选,需要同时传入 AreaCountryProvince

返回参数

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

参数类型示例值描述
DomainListArray of String["example.com"]域名列表
DomainStringexample.com域名
AppStringexample_app应用名称
StreamStringexample_stream直播流名称
ProtocolListArray of String["HTTP-FLV", "RTMP"]推拉流协议
ISPListArray of String["telecom"]运营商
RegionListArray of RegionResponse-CDN 节点 IP 所属区域
UserRegionListArray of RegionResponse-客户端 IP 所属区域
IPListArray of String["10.255.159.000"]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

-

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

说明

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

RegionResponse

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

TrafficData

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

TrafficDetailData

参数类型示例值描述
DomainStringexample.com域名
ProtocolStringHTTP-FLV推拉流协议
ISPStringtelecom运营商
IPString10.255.159.000IP 地址
TotalUpTrafficFloat20上行总流量,单位为 GB
TotalDownTrafficFloat20下行总流量,单位为 GB
TrafficDataListArray of TrafficData-时间粒度数据

示例

请求示例

POST https://live.volcengineapi.com?Action=DescribeLiveMetricTrafficData&Version=2020-08-01
{
  "DomainList": [
    "example.com"
  ],
  "ProtocolList": [
    "HTTP-FLV",
    "RTMP"
  ],
  "ISPList": [
    "telecom"
  ],
  "IPList": [
    "10.255.159.000"
  ],
  "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": "DescribeLiveMetricTrafficData",
    "Version": "2020-08-01",
    "Service": "live",
    "Region": "cn-north-1"
  },
  "Result": {
    "DomainList": [
      "example.com"
    ],
    "ProtocolList": [
      "HTTP-FLV",
      "RTMP"
    ],
    "ISPList": [
      "telecom"
    ],
    "IPList": [
      "10.255.159.000"
    ],
    "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
          }
        ]
      }
    ]
  }
}

错误码

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