You need to enable JavaScript to run this app.
导航
视频直播
  • 文档首页
    • /
  • 视频直播

查询直播流或域名的回源带宽监控数据

最近更新时间：2023.12.04 11:00:43

首次发布时间：2023.09.25 14:36:18

我的收藏

查询一定时间范围内直播拉流或域名的回源带宽监控数据。

注意事项

  • 请求频率：单用户请求频率限制为 100 次/秒。
  • 数据延迟：时间粒度为 60 秒时，数据延迟为 5 分钟；其他时间粒度时，数据延迟为 15分钟。
  • 数据进制：带宽数据统计进制为 1000，例如，1 Mbps = 1000 Kbps。

请求说明

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

请求参数

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

Query

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

Body

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

DomainList

Array of String

否

["example.com", "example2.com"]

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

说明

DomainList 和 Domain 传且仅传一个。

Domain

String

否

example.com

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

App

String

否

example_app

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

Stream

String

否

example_stream

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

ISPList

Array of String

否

["telecom"]

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

  • unicom：联通；
  • railcom：铁通；
  • telecom：电信；
  • mobile：移动；
  • cernet：教育网；
  • tianwei：天威；
  • alibaba：阿里巴巴；
  • tencent：腾讯；
  • drpeng：鹏博士；
  • btvn：广电；
  • huashu：华数；
  • other：其他。
UserRegionListArray of UserRegionList否-区域列表。
IPListArray of String否["10.255.159.000"]查询单个或多个出口外网 IP 地址数据，第四个地址位需要改为 000。例如，实际 IP 地址为 10.255.159.10，则请求时取 10.255.159.000。
StartTimeString是2021-04-13T00:00:00+08:00查询的起始时间，RFC3339 格式的 UTC 时间，精度为 s。
EndTimeString是2021-04-14T00:00:00+08:00查询的结束时间，RFC3339 格式的 UTC 时间，精度为 s。

Aggregation

Integer

否

300

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

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

DetailField

Array of String

否

20

用于指定数据拆分的维度。缺省情况下，表示只显示总回源带宽峰值，不做数据拆维展示。支持的取值如下所示。

  • Domain：按域名拆分数据；
  • ISP：按运营商拆分数据。
    例如，"DetailField":["Domain"]，则返回 DomainList 中每个域名的回源带宽峰值。

UserRegionList

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

返回参数

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

参数类型示例值描述
DomainListArray of String["example.com", "example2.com"]域名列表。
DomainStringexample.com域名。
AppStringexample_app应用名称。
StreamStringexample_stream流名称。
ISPListArray of String["telecom"]运营商。
UserRegionListArray of UserRegionListResponse-区域。
IPListArray of String["10.255.159.000"]IP 地址。
DetailFieldArray of String["Domain"]数据拆分的维度。
StartTimeString2021-04-13T00:00:00+08:00起始时间
EndTimeString2021-04-14T00:00:00+08:00结束时间
AggregationInteger300时间粒度
PeakBandwidthFloat20回源带宽峰值，单位为 Mbps
BandwidthDataListArray of BandwidthDataList-所有时间粒度数据
BandwidthDetailDataListArray of BandwidthDetailDataList-过滤字段和时间聚合后的数据

UserRegionListResponse

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

BandwidthDataList

参数类型示例值描述
TimeStampString2022-04-13T00:00:00+08:00时间片起始时刻。RFC3339 格式的 UTC 时间，精度为 s。
BandwidthFloat20时间片内回源带宽峰值，单位 Mbps。

BandwidthDetailDataList

参数类型示例值描述
DomainStringexample.com域名。
ISPStringtelecom运营商。
IPString10.255.159.000IP 地址。
PeakBandwidthFloat20回源带宽峰值，单位为 Mbps。
BandwidthDataListArray of BandwidthDataList-时间粒度数据。

示例

请求示例

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

{
    "DomainList": ["example.com", "example2.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": [
      "example.com",
      "example2.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": "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": "example2.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.内部服务超时，请联系技术支持。