最近更新时间：2023.08.07 11:52:07
首次发布时间：2022.07.08 13:48:55
查询一定时间范围内，直播拉流转推至第三方的带宽用量。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | DescribePullToPushBandwidthData | 接口名称。当前 API 的名称为 DescribePullToPushBandwidthData。 |
| Version | String | 是 | 2020-08-01 | 接口版本。当前 API 的版本为 2020-08-01。 |
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| DomainList | Array of String | 否 | ["example.com"] | 推流域名列表，缺省情况表示当前账号下的所有域名 |
| StartTime | String | 是 | 2021-04-13T00:00:00+08:00 | 查询的起始时间，起始时间应早于当前时间，RFC3339 格式的 UTC 时间，精度为 s，例如，2022-04-13T00:00:00+08:00 |
| EndTime | String | 是 | 2021-04-14T00:00:00+08:00 | 查询的结束时间，结束时间需晚于起始时间 StartTime，RFC3339 格式的 UTC 时间，精度为 s，例如，2022-04-14T00:00:00+08:00 |
Aggregation | Integer | 否 |
| 时间粒度，单位为 s，默认值为 300。
|
DstAddrTypeList | Array of String | 否 |
| 推流地址类型。缺省情况下表示查询Third。支持 2 种取值。
|
ShowDetail | Boolean | 否 |
| 是否展示过滤字段和时间聚合后的详细数据，默认值为 false。
|
下表仅列出本接口特有的返回参数。更多信息请见返回结构。
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| DomainList | Array of String | ["example.com"] | 域名列表 |
| StartTime | String | 2021-04-13T00:00:00+08:00 | 查询的起始时间 |
| EndTime | String | 2021-04-14T00:00:00+08:00 | 查询的结束时间 |
| Aggregation | Integer | 300 | 时间粒度 |
DstAddrTypeList | Array of String |
| 推流地址类型。
|
ShowDetail | Boolean |
| 是否展示过滤字段和时间聚合后的详细数据，默认值为 false。
|
| PeakUpBandwidth | Float | 12.0 | 转推带宽峰值，单位为 Mbps |
| BandwidthDataList | Array of BandwidthData | - | 所有时间粒度数据 |
BandwidthDetailDataList | Array of BandwidthDetailData |
| 过滤字段和时间聚合后的数据 说明 请求时， |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| TimeStamp | String | 2022-04-13T00:00:00+08:00 | 时间片起始时刻。RFC3339 格式的 UTC 时间，精度为 s，例如，2022-04-13T00:00:00+08:00 |
| UpBandwidth | Float | 12.0 | 转推带宽，单位为 Mbps |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| Domain | String | example.com | 域名 |
DstAddrType | String |
| 推流地址类型。
|
| PeakUpBandwidth | Float | 12.0 | 转推带宽峰值，单位为 Mbps |
| BandwidthDataList | Array of BandwidthData | - | 所有时间粒度数据 |
POST https://live.volcengineapi.com?Action=DescribePullToPushBandwidthData&Version=2020-08-01 { "DomainList": [ "example.com" ], "DstAddrTypeList": [ "live", "Third" ], "StartTime": "2021-04-13T00:00:00+08:00", "EndTime": "2021-04-14T00:00:00+08:00", "Aggregation": 300, "ShowDetail": true }
{ "ResponseMetadata":{ "RequestId": "201806041104200100100232280022D30", "Action": "DescribePullToPushBandwidthData", "Version": "2020-08-01", "Service": "live", "Region": "cn-north-1" }, "Result":{ "DomainList": ["example.com"], "DstAddrTypeList": ["Live","Third"], "StartTime": "2021-04-13T00:00:00+08:00", "EndTime": "2021-04-14T00:00:00+08:00", "Aggregation": 300, "ShowDetail": true, "PeakUpBandwidth": 12.0, "BandwidthDataList": [ { "TimeStamp": "2022-04-13T00:00:00+08:00", "UpBandwidth": 12.0, }, { "TimeStamp": "2022-04-13T00:00:05+08:00", "UpBandwidth": 10.0, } ], "BandwidthDetailDataList": [ { "DstAddrType": "Live", "PeakUpBandwidth": 12.0, "BandwidthDataList": [ { "TimeStamp": "2022-04-13T00:00:00+08:00", "UpBandwidth": 12.0, }, { "TimeStamp": "2022-04-13T00:00:05+08:00", "UpBandwidth": 10.0, } ] }, { "DstAddrType": "Third", "PeakUpBandwidth": 12.0, "BandwidthDataList": [ { "TimeStamp": "2022-04-13T00:00:00+08:00", "UpBandwidth": 12.0, }, { "TimeStamp": "2022-04-13T00:00:05+08:00", "UpBandwidth": 10.0, } ] } ] } }
访问公共错误码获取详细信息。