You need to enable JavaScript to run this app.
最新活动
产品
解决方案
定价
生态与合作
支持与服务
开发者
了解我们
导航

查询 95 带宽峰值

最近更新时间2023.09.25 21:09:56

首次发布时间2021.11.22 11:40:05

支持查询用户账号维度上行和下行的 95 带宽峰值。

说明

该接口数据历史版本 API,我们计划于 2023 年 12 月 25 日停止对其进行维护,并于 2024 年 3 月 25 日下线文档,建议您使用新版查询95带宽峰值接口。

注意事项

请求频率:单用户请求频率限制为 100次/分钟

请求说明

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

请求参数

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

Query

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

Body

参数类型是否必选示例值描述
DomainListArray of String["example.com"]域名列表,缺省情况下表示查询所有域名
StartTimeString2021-04-13T00:00:00+08:00查询的起始时间,RFC3339 格式的 UTC 时间,精度为 s。支持的历史查询时间范围为 93 天
EndTimeString2021-04-14T00:00:00+08:00查询的结束时间,RFC3339 格式的 UTC 时间,精度为 s,支持的历史查询时间范围为 93 天
AggregationInteger300时间粒度,单位为 s,默认值为 300,支持的取值为 300。

ProtocolList

Array of String

["HTTP-FLV", "HTTP-HLS"]

推拉流协议,缺省情况下表示所有协议类型。支持的协议如下所示。

  • HTTP-FLV
  • HTTP-HLS
  • RTMP
  • RTM
  • SRT
  • QUIC

说明

如果设置推拉流协议为 QUIC,不能同时传其他协议。

RegionList

Array of Region

-

CDN 节点 IP 所属区域的列表。缺省情况下表示所有区域。

说明

不支持同时传入 RegionList 和 UserRegionList

UserRegionList

Array of Region

-

客户端 IP 所属区域的列表,缺省情况下表示所有区域。

说明

不支持同时传入 RegionList 和 UserRegionList

Region

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

返回参数

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

参数类型示例值描述
DomainListArray of String["example.com"]域名列表
StartTimeString2021-04-13T00:00:00+08:00起始时间
EndTimeString2021-04-14T00:00:00+08:00结束时间
AggregationInteger300时间粒度
ProtocolListArray of String["HTTP-FLV", "HTTP-HLS"]推拉流协议
RegionListArray of RegionResponse-CDN 节点 IP 所属区域的列表。缺省情况下表示所有区域。
UserRegionListArray of RegionResponse-客户端 IP 所属区域的列表,缺省情况下表示所有区域。

P95PeakBandwidth

Float

100

上下行带宽 95 峰值

说明

如果请求时,Regionlist 中传入多个 region,则返回这些 region 的上下行带宽 95 峰值总和。

P95PeakTimestampString2022-04-18T22:00:00+08:0095 带宽峰值对应的时间点

RegionResponse

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

示例

请求示例

POST https://live.volcengineapi.com?Action=DescribeLiveP95PeakBandwidthData&Version=2020-08-01
{
  "StartTime": "2022-04-18T20:00:00+08:00",
  "EndTime": "2022-04-18T22:00:00+08:00",
  "Aggregation": 300
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "201806041104200100100232280022D30",
    "Action": "DescribeLiveP95PeakBandwidthData",
    "Version": "2020-08-01",
    "Service": "live",
    "Region": "cn-north-1"
  },
  "Result": {
    "StartTime": "2022-04-18T20:00:00+08:00",
    "EndTime": "2022-04-18T22:00:00+08:00",
    "Aggregation": 300,
    "P95PeakBandwidth": 100,
    "P95PeakTimestamp": "2022-04-18T22:00:00+08:00"
  }
}

错误码

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