最近更新时间:2023.09.25 21:10:01
首次发布时间:2022.09.14 17:56:25
查询一定时间范围内直播拉流或域名的回源带宽监控数据。
说明
该接口数据历史版本 API,我们计划于 2023 年 12 月 25 日停止对其进行维护,并于 2024 年 3 月 25 日下线文档,建议您使用新版查询直播流或域名的回源带宽监控数据接口。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeLiveSourceBandwidthData | 接口名称。当前 API 的名称为 DescribeLiveSourceBandwidthData 。 |
Version | String | 是 | 2020-08-01 | 接口版本。当前 API 的版本为 2020-08-01 。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
DomainList | Array of String | 否 |
| 域名列表。缺省情况表示该用户的所有域名。 说明
|
Domain | String | 否 |
| 查询流粒度数据时的域名参数,支持拉流域名。 |
App | String | 否 |
| 查询流粒度数据时的应用名参数。 |
Stream | String | 否 |
| 查询流粒度数据时的流名称参数。 |
ISPList | Array of String | 否 |
| 运营商,缺省情况下,表示查询所有运营商,支持的运营商如下所示。
|
UserRegionList | Array of UserRegionList | 否 | - | 区域列表 |
IPList | Array of String | 否 | ["10.255.159.000"] | 查询单个或多个出口外网 IP 地址数据,第四个地址位需要改为 000。例如,实际 IP 地址为 10.255.159.10,则请求时取 10.255.159.000 |
StartTime | String | 是 | 2021-04-13T00:00:00+08:00 | 查询的起始时间,RFC3339 格式的 UTC 时间,精度为 s,例如,2022-04-01T00:00:00+08:00 |
EndTime | String | 是 | 2021-04-14T00:00:00+08:00 | 查询的结束时间,RFC3339 格式的 UTC 时间,精度为 s,例如,2022-04-02T00:00:00+08:00 |
Aggregation | Integer | 否 |
| 聚合的时间粒度,单位为 s,默认值为 300。支持如下时间粒度。
|
DetailField | Array of String | 否 |
| 用于指定数据拆分的维度。缺省情况下,表示只显示总回源带宽峰值,不做数据拆维展示。支持的取值如下所示。
|
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Area | String | 否 | CN | 大区,映射关系请参见区域映射 |
Country | String | 否 | CN | 国家,映射关系请参见区域映射。如果按国家筛选,需要同时传入 Area 和 Country 。 |
Province | String | 否 | beijing | 国内为省,国外暂不支持该参数,映射关系请参见区域映射。如果按省筛选,需要同时传入 Area 、Country 和 Province 。 |
下表仅列出本接口特有的返回参数。更多信息请见返回结构。
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
DomainList | Array of String | ["example.com", "example2.com"] | 域名列表 |
Domain | String | example.com | 域名 |
App | String | example_app | 应用名称 |
Stream | String | example_stream | 流名称 |
ISPList | Array of String | ["telecom"] | 运营商 |
UserRegionList | Array of UserRegionListResponse | - | 区域 |
IPList | Array of String | ["10.255.159.000"] | IP 地址 |
DetailField | Array of String |
| 数据拆分的维度。
|
StartTime | String | 2021-04-13T00:00:00+08:00 | 起始时间 |
EndTime | String | 2021-04-14T00:00:00+08:00 | 结束时间 |
Aggregation | Integer | 300 | 时间粒度 |
PeakBandwidth | Float | 20 | 回源带宽峰值,单位为 Mbps |
BandwidthDataList | Array of BandwidthDataList | - | 所有时间粒度数据 |
BandwidthDetailDataList | Array of BandwidthDetailDataList | - | 过滤字段和时间聚合后的数据 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
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 |
Bandwidth | Float | 20 | 时间片内回源带宽峰值,单位 Mbps |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Domain | String | example.com | 域名 |
ISP | String | telecom | 运营商 |
IP | String | 10.255.159.000 | IP 地址 |
PeakBandwidth | Float | 20 | 回源带宽峰值,单位为 Mbps |
BandwidthDataList | Array of BandwidthDataList | - | 时间粒度数据 |
POST https://live.volcengineapi.com?Action=DescribeLiveSourceBandwidthData&Version=2020-08-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 } ] } ] } }
访问公共错误码获取详细信息。