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

查询直播域名带宽用量

最近更新时间2023.12.05 11:57:53

首次发布时间2023.09.25 14:35:35

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

  • 支持按照域名维度(含删除域名)查询;
  • 支持按照 5 分钟,1 小时和 1 天粒度聚合;
  • 上行带宽峰值取 BandwidthDataList Up 最大值;
  • 下行带宽峰值取 BandwidthDataList Down 最大值。

注意事项

  • 请求频率:单用户请求频率限制为 100 次/秒
  • 数据延迟:数据延迟为 15 分钟
  • 数据进制:带宽数据统计进制为 1000,例如,1 Mbps = 1000 Kbps。

请求说明

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

请求参数

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

Query

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

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

  • 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。
EndTimeString2021-04-14T00:00:00+08:00查询的结束时间,RFC3339 格式的 UTC 时间,精度为 s。

Aggregation

Integer

300

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

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

Region

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

返回参数

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

参数类型示例值描述
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时间粒度。
DetailFieldArray of String["Domain"]数据拆分的维度。
PeakUpBandwidthFloat20上行峰值,单位为 Mbps。
PeakDownBandwidthFloat20下行峰值,单位为 Mbps。
BandwidthDataListArray of BandwidthData-所有时间粒度数据。

BandwidthDetailDataList

Array of BandwidthDetailData

-

按维度拆分的数据。

说明

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

RegionResponse

参数类型示例值描述
AreaStringCN大区标识符。
CountryStringCN国家标识符。
ProvinceStringbeijing省份标识符。

BandwidthData

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

BandwidthDetailData

参数类型示例值描述
DomainStringexample.com域名。
ProtocolStringRTMP推拉流协议。
ISPStringtelecom运营商。
PeakUpBandwidthFloat20上行峰值,单位为 Mbps。
PeakDownBandwidthFloat20下行峰值,单位为 Mbps。
BandwidthDataListArray of BandwidthData-带宽用量数据。

示例

请求示例

POST https://live.volcengineapi.com?Action=DescribeLiveBandwidthData&Version=2023-01-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,
  "DetailField": [
    "Protocol"
  ]
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "201806041104200100100232280022D30",
    "Action": "DescribeLiveBandwidthData",
    "Version": "2023-01-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,
    "PeakUpBandwidth": 20,
    "PeakDownBandwidth": 20,
    "BandwidthDataList": [
      {
        "TimeStamp": "2022-04-13T00:00:00+08:00",
        "UpBandwidth": 20,
        "DownBandwidth": 20
      },
      {
        "TimeStamp": "2022-04-13T00:05:00+08:00",
        "UpBandwidth": 20,
        "DownBandwidth": 20
      }
    ],
    "BandwidthDetailDataList": [
      {
        "Protocol": "HTTP-FLV",
        "PeakUpBandwidth": 20,
        "PeakDownBandwidth": 20,
        "BandwidthDataList": [
          {
            "TimeStamp": "2022-04-13T00:00:00+08:00",
            "UpBandwidth": 20,
            "DownBandwidth": 20
          },
          {
            "TimeStamp": "2022-04-13T00:05:00+08:00",
            "UpBandwidth": 20,
            "DownBandwidth": 20
          }
        ]
      },
      {
        "Protocol": "RTMP",
        "PeakUpBandwidth": 0,
        "PeakDownBandwidth": 0,
        "BandwidthDataList": [
          {
            "TimeStamp": "2022-04-13T00:00:00+08:00",
            "UpBandwidth": 0,
            "DownBandwidth": 0
          },
          {
            "TimeStamp": "2022-04-13T00:05:00+08:00",
            "UpBandwidth": 0,
            "DownBandwidth": 0
          }
        ]
      }
    ]
  }
}

错误码

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

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