You need to enable JavaScript to run this app.
导航
查询直播流或域名的回源带宽监控数据
最近更新时间:2024.05.13 16:21:19首次发布时间:2023.09.25 14:36:18

调用 DescribeLiveSourceBandwidthData 接口,查询指定时间范围内拉流域名或回源流产生的回源带宽监控数据。

注意事项

  • 使用限制:支持查询指定拉流域名下(包含已删除域名)或指定回源流产生的回源带宽数据。
  • 请求频率:单用户请求频率限制为 30 次/秒
  • 数据延迟:时间粒度为 60 秒时,数据延迟为 5 分钟;其他时间粒度时,数据延迟为 15分钟
  • 数据进制:带宽数据统计进制为 1000,例如,1 Mbps = 1000 Kbps。

请求说明

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

调试

请求参数

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

Query

参数类型是否必选示例值描述
ActionStringDescribeLiveSourceBandwidthData接口名称。当前 API 的名称为 DescribeLiveSourceBandwidthData
VersionString2023-01-01接口版本。当前 API 的版本为 2023-01-01

Body

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

DomainList

Array of String

["pull.example.com", "pull2.example.com"]

拉流域名列表,默认为空,表示查询所有域名的回源带宽监控数据。您可以调用 ListDomainDetail 接口或在视频直播控制台的域名管理页面,获取待查询的拉流域名。

说明

DomainListDomain 传且仅传一个。

Domain

String

pull.example.com

拉流域名,查询流粒度数据时必传,且需同时传入 App 和 Stream。您可以调用 ListDomainDetail 接口或在视频直播控制台的域名管理页面,获取待查询的拉流域名。

说明

查询流粒度的回源带宽监控数据时,需同时指定 DomainAppStream 来指定回源流。

App

String

example_app

回源流的应用名称,查询流粒度数据时必传,且需同时传入 DomainStream。支持由大小写字母(A - Z、a - z)、数字(0 - 9)、下划线(_)、短横线(-)和句点(.)组成,长度为 1 到 30 个字符。

说明

查询流粒度的回源带宽监控数据时,需同时指定 DomainAppStream 来指定回源流。

Stream

String

example_stream

回源流的流名称,查询流粒度数据时必传,且需同时传入 DomainApp。支持由大小写字母(A - Z、a - z)、下划线(_)、短横线(-)和句点(.)组成,长度为 1 到 100 个字符。

说明

查询流粒度的回源带宽监控数据时,需同时指定 DomainAppStream 来指定回源流。

ISPList

Array of String

["telecom"]

提供网络接入服务的运营商标识符,缺省情况下表示所有运营商,支持的运营商如下所示。

  • unicom:联通;
  • railcom:铁通;
  • telecom:电信;
  • mobile:移动;
  • cernet:教育网;
  • tianwei:天威;
  • alibaba:阿里巴巴;
  • tencent:腾讯;
  • drpeng:鹏博士;
  • btvn:广电;
  • huashu:华数;
  • other:其他。
    您也可以通过 DescribeLiveISPData 接口获取运营商对应的标识符。
UserRegionListArray of UserRegionList-客户端 IP 所属区域的列表,缺省情况下表示所有区域。
StartTimeString2021-04-13T00:00:00+08:00查询的开始时间,RFC3339 格式的时间戳,精度为秒。
EndTimeString2021-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

20

数据拆分的维度,默认为空表示不按维度进行数据拆分,支持的维度如下所示。

  • Domain:域名;
  • ISP:运营商。

说明

配置数据拆分的维度时,对应的维度参数传入多个值时才会返回按此维度拆分的数据。例如,配置按 Domain 进行数据拆分时, DomainList 传入多个 Domain 值时,才会返回按 Domain 拆分的数据。

UserRegionList

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

返回参数

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

参数类型示例值描述
DomainListArray of String["pull.example.com", "pull2.example.com"]域名列表。
DomainStringpull.example.com查询流粒度数据时的域名。
AppStringlive查询流粒度数据时的应用名称。
StreamStringexample_stream查询流粒度数据时的流名称。

ISPList

Array of String

["telecom"]

提供网络接入服务的运营商标识符,标识符与运营商的对应关系如下。

  • unicom:联通;
  • railcom:铁通;
  • telecom:电信;
  • mobile:移动;
  • cernet:教育网;
  • tianwei:天威;
  • alibaba:阿里巴巴;
  • tencent:腾讯;
  • drpeng:鹏博士;
  • btvn:广电;
  • huashu:华数;
  • other:其他。
UserRegionListArray of UserRegionListResponse-客户端 IP 所属区域列表。

DetailField

Array of String

["Domain"]

数据拆分的维度,维度说明如下所示。

  • Domain:域名;
  • ISP:运营商。
StartTimeString2021-04-13T00:00:00+08:00查询的开始时间,RFC3339 格式的时间戳,精度为秒。
EndTimeString2021-04-14T00:00:00+08:00查询的结束时间,RFC3339 格式的时间戳,精度为秒。

Aggregation

Integer

300

聚合的时间粒度,单位为秒。

  • 60:1 分钟;
  • 300:5 分钟;
  • 3600:1 小时。
PeakBandwidthFloat20查询时间范围内的回源峰值带宽,单位为 Mbps。
BandwidthDataListArray of BandwidthDataList-所有时间粒度的数据。
BandwidthDetailDataListArray of BandwidthDetailDataList-按维度拆分后的数据。

UserRegionListResponse

参数类型示例值描述
AreaStringCN区域信息中的大区标识符。
CountryStringCN区域信息中的国际标识符。
ProvinceStringbeijing区域信息中的省份标识符。

BandwidthDataList

参数类型示例值描述
TimeStampString2022-04-13T00:00:00+08:00数据按时间粒度聚合时,每个时间粒度的开始时间,RFC3339 格式的时间戳,精度为秒。
BandwidthFloat20当前数据聚合时间粒度内的回源峰值带宽,单位为 Mbps。

BandwidthDetailDataList

参数类型示例值描述
DomainStringexample.com按域名维度进行数据拆分时的域名信息。
ISPStringtelecom按运营商维度进行数据拆分时的运营商信息。
PeakBandwidthFloat20按维度进行数据拆分后,当前维度的回源峰值带宽,单位为 Mbps。
BandwidthDataListArray of BandwidthDataList-按维度进行数据拆分后,当前维度下所有时间粒度的数据。

请求示例

POST https://live.volcengineapi.com?Action=DescribeLiveSourceBandwidthData&Version=2023-01-01

{
    "DomainList": ["pull.example.com", "pull2.example.com"],
    "ISPList": ["telecom"],
    "UserRegionList": [
        {
            "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": ["Domain"]
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "201806041104200100100232280022D30",
    "Action": "DescribeLiveSourceBandwidthData",
    "Version": "2018-01-01",
    "Service": "live",
    "Region": "cn-langfang-1"
  },
  "Result": {
    "DomainList": [
      "pull.example.com",
      "pull2.example.com"
    ],
    "ISPList": [
      "telecom"
    ],
    "DetailField": [
      "Domain"
    ],
    "UserRegionList": [
      {
        "Area": "CN",
        "Country": "CN",
        "Province": "beijing"
      }
    ],
    "StartTime": "2021-04-13T00:00:00+08:00",
    "EndTime": "2021-04-14T00:00:00+08:00",
    "Aggregation": 300,
    "PeakBandwidth": 20,
    "BandwidthDataList": [
      {
        "TimeStamp": "2022-04-13T00:00:00+08:00",
        "Bandwidth": 20
      },
      {
        "TimeStamp": "2022-04-13T00:05:00+08:00",
        "Bandwidth": 20
      }
    ],
    "BandwidthDetailDataList": [
      {
        "Domain": "pull.example.com",
        "PeakBandwidth": 20,
        "BandwidthDataList": [
          {
            "TimeStamp": "2022-04-13T00:00:00+08:00",
            "Bandwidth": 20
          },
          {
            "TimeStamp": "2022-04-13T00:05:00+08:00",
            "Bandwidth": 20
          }
        ]
      },
      {
        "Domain": "pull2.example.com",
        "PeakBandwidth": 0,
        "BandwidthDataList": [
          {
            "TimeStamp": "2022-04-13T00:00:00+08:00",
            "Bandwidth": 0
          },
          {
            "TimeStamp": "2022-04-13T00:05:00+08:00",
            "Bandwidth": 0
          }
        ]
      }
    ]
  }
}

错误码

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

状态码错误码错误信息说明
200CommonErr-未分类错误。建议重试,如果仍返回该错误码,请联系技术支持
400InvalidParam-输入的参数无效或不符合要求,请参照请求参数说明进行检查。
400InvalidParam.BindErrorRequest parameter error, please check input data参数未通过校验,请检查参数类型是否正确。
403RequestForbidden-请求被拒绝,当前账号下无请求的资源(域名空间、域名、应用、配置模版、证书)。
404ResourceNotFound-未找到资源(域名空间、域名、应用、配置模版、证书)。建议重试,如果仍返回该错误码,请联系技术支持
500InternalErroran internal error 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.内部服务超时,请联系技术支持

服务端 SDK

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