DescribeLiveP95PeakBandwidthData - 查询 95 带宽峰值--视频直播-火山引擎

文档中心

立即注册

导航

DescribeLiveP95PeakBandwidthData - 查询 95 带宽峰值

最近更新时间：2025.04.22 19:10:54首次发布时间：2023.09.25 14:35:35

调用 DescribeLiveP95PeakBandwidthData 接口，查询指定时间范围内直播域名产生的 95 峰值带宽用量，包含推流域名的上行 95 峰值带宽和拉流域名的下行 95 峰值带宽。

注意事项

使用限制：支持查询已删除域名产生的 95 峰值带宽用量数据。
请求频率：单用户请求频率限制为 30 次/秒。
数据延迟：数据延迟为 15 分钟。
数据进制：带宽数据统计进制为 1000，例如，1 Mbps = 1000 Kbps。

请求说明

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

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

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

Query

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

Body

参数	类型	是否必选	示例值	描述
DomainList	Array of String	否	`["push.example.com"]`	域名列表，默认为空，表示查询您视频直播产品下所有域名的 95 峰值带宽用量数据。您可以调用 ListDomainDetail 接口或在视频直播控制台的域名管理页面，获取待查询的域名。
StartTime	String	是	`2021-04-13T00:00:00+08:00`	查询的开始时间，RFC3339 格式的时间戳，精度为秒。说明单次查询最大时间跨度为 93 天，历史查询时间范围为 366 天。
EndTime	String	是	`2021-04-14T00:00:00+08:00`	查询的结束时间，RFC3339 格式的时间戳，精度为秒。
Aggregation	Integer	否	`300`	数据聚合的时间粒度，单位为秒，当前接口默认且仅支持按 `300` 秒进行数据拆分。
ProtocolList	Array of String	否	`["HTTP-FLV", "HTTP-HLS"]`	推拉流协议，缺省情况下表示所有协议类型，支持的协议如下所示。 `HTTP-FLV`：基于 HTTP 协议的推拉流协议，使用 FLV 格式传输视频格式。 `HTTP-HLS`：基于 HTTP 协议的推拉流协议，使用 TS 格式传输视频格式。 `RTMP`：Real Time Message Protocol，实时信息传输协议。 `RTM`：Real Time Media，超低延时直播协议。 `SRT`：Secure Reliable Transport，安全可靠传输协议。 `QUIC`：Quick UDP Internet Connections，一种基于 UDP 的全新的低延时互联网传输协议。说明如果查询推拉流协议为 `QUIC`，不能同时查询其他协议。
RegionList	Array of Region	否	`-`	CDN 节点 IP 所属区域的列表，缺省情况下表示所有区域。说明参数 `RegionList`和`UserRegionList` 不支持同时传入。
UserRegionList	Array of Region	否	`-`	客户端 IP 所属区域的列表，缺省情况下表示所有区域。说明参数 `RegionList`和`UserRegionList` 不支持同时传入。

Region

参数	类型	是否必选	示例值	描述
Area	String	否	`CN`	区域信息中的大区标识符，如何获取请参见查询区域标识符。
Country	String	否	`CN`	区域信息中的国家标识符，如何获取请参见查询区域标识符。如果按国家筛选，需要同时传入 `Area` 和 `Country`。
Province	String	否	`beijing`	区域信息中的省份标识符，如何获取请参见查询区域标识符。如果按省筛选，需要同时传入 `Area`、`Country` 和 `Province`。

返回参数

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

参数	类型	示例值	描述
DomainList	Array of String	`["push.example.com"]`	域名列表。
StartTime	String	`2022-04-18T20:00:00+08:00`	查询的开始时间，RFC3339 格式的时间戳，精度为秒。
EndTime	String	`2022-04-18T22:00:00+08:00`	查询的结束时间，RFC3339 格式的时间戳，精度为秒。
Aggregation	Integer	`300`	数据聚合的时间粒度，单位为秒。 `300`：5 分钟。
ProtocolList	Array of String	`["HTTP-FLV", "HTTP-HLS"]`	推拉流协议，协议说明如下。 `HTTP-FLV`：基于 HTTP 协议的推拉流协议，使用 FLV 格式传输视频格式。 `HTTP-HLS`：基于 HTTP 协议的推拉流协议，使用 TS 格式传输视频格式。 `RTMP`：Real Time Message Protocol，实时信息传输协议。 `RTM`：Real Time Media，超低延时直播协议。 `SRT`：Secure Reliable Transport，安全可靠传输协议。 `QUIC`：Quick UDP Internet Connections，一种基于 UDP 的全新的低延时互联网传输协议。
RegionList	Array of Region	`-`	CDN 节点 IP 所属区域的列表。
UserRegionList	Array of Region	`-`	客户端 IP 所属区域的列表。
P95PeakBandwidth	Float	`100`	时间范围内的上下行 95 峰值带宽总和。说明如果请求时，`Regionlist` 中传入多个 region，则返回这些 region 的上下行带宽 95 峰值总和。
P95PeakTimestamp	String	`2022-04-18T22:00:00+08:00`	95 峰值带宽的时间戳，RFC3339 格式的时间戳，精度为秒。

Region

参数	类型	示例值	描述
Area	String	`CN`	区域信息中的大区标识符。
Country	String	`CN`	区域信息中的国家标识符。
Province	String	`beijing`	区域信息中的省份标识符。

请求示例

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"
    }
}

错误码

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

状态码	错误码	错误信息	说明
400	InvalidParam	-	输入的参数无效或不符合要求，请参照请求参数说明进行检查。
403	RequestForbidden	-	请求被拒绝，当前账号下无请求的资源（域名空间、域名、应用、配置模版、证书）。
500	InternalError	an internal error occurred, please contact the administrator.	出现内部错误，请联系技术支持。

服务端 SDK

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