最近更新时间:2023.12.04 11:00:42
首次发布时间:2023.09.25 14:35:35
查询一定时间范围内,直播拉流转推至第三方的带宽用量。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeLivePullToPushBandwidthData | 接口名称。当前 API 的名称为 DescribeLivePullToPushBandwidthData 。 |
Version | String | 是 | 2023-01-01 | 接口版本。当前 API 的版本为 2023-01-01 。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
DomainList | Array of String | 否 | ["example.com"] | 推流域名列表,缺省情况表示当前账号下的所有域名。 |
StartTime | String | 是 | 2021-04-13T00:00:00+08:00 | 查询的起始时间,RFC3339 格式的 UTC 时间,精度为 s。 |
EndTime | String | 是 | 2021-04-14T00:00:00+08:00 | 查询的结束时间,RFC3339 格式的 UTC 时间,精度为 s。 |
Aggregation | Integer | 否 |
| 时间粒度,单位为 s,默认值为 300。
|
DstAddrTypeList | Array of String | 否 |
| 推流地址类型,缺省情况下表示查询 Third,支持 2 种取值。
|
DetailField | Array of String | 否 | ["Domain"] | 数据拆分的维度,可取值为 "Domain","DstAddrType",设置为空时不进行数据拆分。 |
下表仅列出本接口特有的返回参数。更多信息请见返回结构。
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
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 |
| 推流地址类型。
|
DetailField | Array of String | ["Domain"] | 数据拆分的维度。 |
PeakUpBandwidth | Float | 12 | 转推带宽峰值,单位为 Mbps。 |
BandwidthDataList | Array of BandwidthDataList | - | 所有时间粒度数据。 |
BandwidthDetailDataList | Array of BandwidthDetailDataList | - | 过滤字段和时间聚合后的数据。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
TimeStamp | String | 2022-04-13T00:00:00+08:00 | 时间片起始时刻。RFC3339 格式的 UTC 时间,精度为 s。 |
UpBandwidth | Float | 12.0 | 转推带宽,单位为 Mbps。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Domain | String | example.com | 域名。 |
DstAddrType | String |
| 推流地址类型。
|
PeakUpBandwidth | Float | 12.0 | 转推带宽峰值,单位为 Mbps。 |
BandwidthDataList | Array of BandwidthDataList | - | 所有时间粒度数据。 |
POST https://live.volcengineapi.com?Action=DescribeLivePullToPushBandwidthData&Version=2023-01-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, "DetailField": [ "Domain" ] }
{ "ResponseMetadata": { "RequestId": "201806041104200100100232280022D30", "Action": "DescribeLivePullToPushBandwidthData", "Version": "2023-01-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, "DetailField": [ "Domain" ], "PeakUpBandwidth": 12, "BandwidthDataList": [ { "TimeStamp": "2022-04-13T00:00:00+08:00", "UpBandwidth": 12 }, { "TimeStamp": "2022-04-13T00:00:05+08:00", "UpBandwidth": 10 } ], "BandwidthDetailDataList": [ { "DstAddrType": "Live", "PeakUpBandwidth": 12, "BandwidthDataList": [ { "TimeStamp": "2022-04-13T00:00:00+08:00", "UpBandwidth": 12 }, { "TimeStamp": "2022-04-13T00:00:05+08:00", "UpBandwidth": 10 } ] }, { "DstAddrType": "Third", "PeakUpBandwidth": 12, "BandwidthDataList": [ { "TimeStamp": "2022-04-13T00:00:00+08:00", "UpBandwidth": 12 }, { "TimeStamp": "2022-04-13T00:00:05+08:00", "UpBandwidth": 10 } ] } ] } }
下表仅列出本接口特有的错误码。更多信息请参见公共错误码获取详细信息。
状态码 | 错误码 | 错误信息 | 说明 |
---|---|---|---|
200 | CommonErr | - | 未分类错误。建议重试,如果仍返回该错误码,请联系技术支持。 |
400 | InvalidParam | - | 输入的参数无效或不符合要求,请参照请求参数说明进行检查。 |
400 | InvalidParam.BindError | Request parameter error, please check input data | 参数未通过校验,请检查参数类型是否正确。 |
403 | RequestForbidden | - | 请求被拒绝,当前账号下无请求的资源(域名空间、域名、应用、配置模版、证书)。 |
404 | ResourceNotFound | - | 未找到资源(域名空间、域名、应用、配置模版、证书)。建议重试,如果仍返回该错误码,请联系技术支持。 |
500 | InternalError | an internal error occurred, please contact the administrator. | 出现内部错误,请联系技术支持。 |
502 | InternalServiceError | an internal error occurred, please contact the administrator. | 服务间出现错误,请联系技术支持。 |
502 | InternalServiceError.BadResponse | an internal error occurred, please contact the administrator. | 服务间出现错误,请联系技术支持。 |
504 | InternalServiceTimeout | Internal Service is timeout. please contact the administrator. | 内部服务超时,请联系技术支持。 |