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

查询 95 带宽峰值

最近更新时间2023.12.04 11:00:42

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

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

注意事项

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

请求说明

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

请求参数

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

Query

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

Body

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

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=2023-01-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": "2023-01-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"
  }
}

错误码

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

状态码错误码错误信息说明
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.内部服务超时,请联系技术支持