最近更新时间:2023.09.25 21:09:56
首次发布时间:2021.11.22 11:40:05
查询直播上行、下行(含时移分发)带宽数据。
说明
该接口数据历史版本 API,我们计划于 2023 年 12 月 25 日停止对其进行维护,并于 2024 年 3 月 25 日下线文档,建议您使用新版查询直播域名带宽用量接口。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeLiveBandwidthData | 接口名称。当前 API 的名称为 DescribeLiveBandwidthData 。 |
Version | String | 是 | 2020-08-01 | 接口版本。当前 API 的版本为 2020-08-01 。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
DomainList | Array of String | 否 | ["example.com"] | 域名列表,缺省情况表示该用户的所有域名 |
ProtocolList | Array of String | 否 |
| 推拉流协议,缺省情况下表示所有协议类型。支持的协议如下所示。
说明 如果设置推拉流协议为 QUIC,不能同时传其他协议。 |
ISPList | Array of String | 否 |
| 运营商,缺省情况下,表示查询所有运营商,支持的运营商如下所示。
|
RegionList | Array of Region | 否 | - | CDN 节点 IP 所属区域的列表。缺省情况下表示所有区域。 |
UserRegionList | Array of Region | 否 | - | 客户端 IP 所属区域的列表,缺省情况下表示所有区域。 |
StartTime | String | 是 | 2021-04-13T00:00:00+08:00 | 查询的起始时间,RFC3339 格式的 UTC 时间,精度为 s,例如:2021-04-13T00:00:00+08:00 |
EndTime | String | 是 | 2021-04-14T00:00:00+08:00 | 查询的结束时间,RFC3339 格式的 UTC 时间,精度为 s,例如:2021-04-14T00:00:00+08:00 |
Aggregation | Integer | 否 |
| 时间粒度,单位为 s,默认值为 300。支持如下时间粒度。
|
ShowDetail | Boolean | 否 |
| 是否返回更详细的数据,默认为 false。
|
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Area | String | 否 | CN | 大区,映射关系请参见区域映射 |
Country | String | 否 | CN | 国家,映射关系请参见区域映射。如果按国家筛选,需要同时传入 Area 和 Country 。 |
Province | String | 否 | beijing | 国内为省,国外暂不支持该参数,映射关系请参见区域映射。如果按省筛选,需要同时传入 Area 、Country 和 Province 。 |
下表仅列出本接口特有的返回参数。更多信息请见返回结构。
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
DomainList | Array of String | "example.com"] | 域名列表,代表所查询的域名 |
ProtocolList | Array of String | ["HTTP-FLV", "RTMP"] | 推拉流协议 |
ISPList | Array of String | ["telecom"] | 运营商 |
RegionList | Array of RegionResponse | - | CDN 节点 IP 所属区域 |
UserRegionList | Array of RegionResponse | - | 客户端 IP 所属区域 |
StartTime | String | 2021-04-13T00:00:00+08:00 | 起始时间 |
EndTime | String | 2021-04-14T00:00:00+08:00 | 结束时间 |
Aggregation | Integer | 300 | 时间粒度 |
PeakUpBandwidth | Float | 20 | 上行峰值,单位为 Mbps |
PeakDownBandwidth | Float | 20 | 下行峰值,单位为 Mbps |
BandwidthDataList | Array of BandwidthData | - | 所有时间粒度数据 |
BandwidthDetailDataList | Array of BandwidthDetailData |
| 过滤字段对应的更详细的数据 说明 请求时, |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Area | String | CN | 大区,映射关系请参见区域映射 |
Country | String | CN | 国家,映射关系请参见区域映射 |
Province | String | beijing | 国内为省,国外暂不支持该参数,映射关系请参见区域映射 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
TimeStamp | String | 2022-04-13T00:00:00+08:00 | 时间片起始时刻。RFC3339 格式的 UTC 时间,精度为 s,例如,2022-04-13T00:00:00+08:00 |
UpBandwidth | Float | 20 | 上行带宽,单位为 Mbps |
DownBandwidth | Float | 20 | 下行带宽,单位为 Mbps |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Domain | String | example.com | 域名 |
Protocol | String | RTMP | 推拉流协议 |
ISP | String | ["telecom"] | 运营商 |
PeakUpBandwidth | Float | 20 | 上行峰值,单位为 Mbps |
PeakDownBandwidth | Float | 20 | 下行峰值,单位为 Mbps |
BandwidthDataList | Array of BandwidthData | - | 所有时间粒度数据 |
POST https://live.volcengineapi.com?Action=DescribeLiveBandwidthData&Version=2020-08-01 { "DomainList": ["example.com"], "ProtocolList": ["HTTP-FLV", "RTMP"], "ISPList": ["telecom"], "RegionList": [ { "Area": "CN", "Country": "CN", "Province": "beijing", } ], "StartTime": "2021-04-13T00:00:00+08:00", "EndTime": "2021-04-14T00:00:00+08:00", "Aggregation": 300, "ShowDetail": true }
{ "ResponseMetadata": { "RequestId": "201806041104200100100232280022D30", "Action": "DescribeLiveBandwidthData", "Version": "2020-08-01", "Service": "live", "Region": "cn-north-1" }, "Result": { "DomainList": [ "example.com" ], "ProtocolList": [ "HTTP-FLV", "RTMP" ], "ISPList": [ "telecom" ], "RegionList": [ { "Area": "CN", "Country": "CN", "Province": "beijing" } ], "StartTime": "2021-04-13T00:00:00+08:00", "EndTime": "2021-04-14T00:00:00+08:00", "Aggregation": 300, "PeakUpBandwidth": 20, "PeakDownBandwidth": 20, "BandwidthDataList": [ { "TimeStamp": "2022-04-13T00:00:00+08:00", "UpBandwidth": 20, "DownBandwidth": 20 }, { "TimeStamp": "2022-04-13T00:05:00+08:00", "UpBandwidth": 20, "DownBandwidth": 20 } ], "BandwidthDetailDataList": [ { "Protocol": "HTTP-FLV", "PeakUpBandwidth": 20, "PeakDownBandwidth": 20, "BandwidthDataList": [ { "TimeStamp": "2022-04-13T00:00:00+08:00", "UpBandwidth": 20, "DownBandwidth": 20 }, { "TimeStamp": "2022-04-13T00:05:00+08:00", "UpBandwidth": 20, "DownBandwidth": 20 } ] }, { "Protocol": "RTMP", "PeakUpBandwidth": 0, "PeakDownBandwidth": 0, "BandwidthDataList": [ { "TimeStamp": "2022-04-13T00:00:00+08:00", "UpBandwidth": 0, "DownBandwidth": 0 }, { "TimeStamp": "2022-04-13T00:05:00+08:00", "UpBandwidth": 0, "DownBandwidth": 0 } ] } ] } }
访问公共错误码获取详细信息。