最近更新时间:2024.04.22 15:52:26
首次发布时间:2023.09.25 14:35:35
调用 DescribeLivePullToPushBandwidthData
接口,查询指定时间范围内产生的拉流转推带宽用量。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeLivePullToPushBandwidthData | 接口名称。当前 API 的名称为 DescribeLivePullToPushBandwidthData 。 |
Version | String | 是 | 2023-01-01 | 接口版本。当前 API 的版本为 2023-01-01 。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
DomainList | Array of String | 否 | ["push.example.com"] | 域名列表,默认为空,表示查询您视频直播产品下所有域名下的带宽用量数据。您可以调用 ListDomainDetail 接口或在视频直播控制台的域名管理页面,获取待查询的域名。 |
StartTime | String | 是 | 2021-04-13T00:00:00+08:00 | 查询的开始时间,RFC3339 格式的时间戳,精度为秒。 |
EndTime | String | 是 | 2021-04-14T00:00:00+08:00 | 查询的结束时间,RFC3339 格式的时间戳,精度为秒。 |
Aggregation | Integer | 否 |
| 数据聚合的时间粒度,单位为秒,支持的时间粒度如下所示。
|
DstAddrTypeList | Array of String | 否 |
| 推流地址类型,可选值如下所示。
|
DetailField | Array of String | 否 |
| 数据拆分的维度,缺省情况下不进行数据拆分,支持的维度如下所示。
说明 配置数据拆分维度时,对应的维度参数传入多个值时会返回按维度进行拆分的数据;对应的维度只传入一个值时不返回按此维度进行拆分的数据。 |
下表仅列出本接口特有的返回参数。更多信息请见返回结构。
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
DomainList | Array of String | ["push.example.com"] | 域名列表。 |
StartTime | String | 2021-04-13T00:00:00+08:00 | 查询的开始时间,RFC3339 格式的时间戳,精度为秒。 |
EndTime | String | 2021-04-14T00:00:00+08:00 | 查询的结束时间,RFC3339 格式的时间戳,精度为秒。 |
Aggregation | Integer |
| 数据聚合的时间粒度,单位为秒。
|
DstAddrTypeList | Array of String |
| 推流地址类型。
|
DetailField | Array of String |
| 数据拆分的维度,维度说明如下。
|
PeakUpBandwidth | Float | 12 | 当前查询条件下的拉流转推峰值带宽,单位为 Mbps。 |
BandwidthDataList | Array of BandwidthDataList | - | 所有时间粒度的数据。 |
BandwidthDetailDataList | Array of BandwidthDetailDataList |
| 按维度拆分后的数据。 说明 当配置了数据拆分的维度时,对应的维度参数传入多个值才会返回按维度拆分的数据。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
TimeStamp | String | 2022-04-13T00:00:00+08:00 | 数据按时间粒度聚合时,每个时间粒度的开始时间,RFC3339 格式的时间戳,精度为秒。 |
UpBandwidth | Float | 12.0 | 当前数据聚合时间粒度内的拉流转推峰值带宽,单位为 Mbps。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Domain | String | push.example.com | 按域名维度进行数据拆分时的域名信息。 |
DstAddrType | String | Live | 按推流地址类型维度进行数据拆分时的地址类型信息。 |
PeakUpBandwidth | Float | 12.0 | 查询时间范围内的维度下的拉流转推峰值带宽,单位为 Mbps。 |
BandwidthDataList | Array of BandwidthDataList | - | 按维度进行数据拆分后,当前维度下所有时间粒度的数据。 |
POST https://live.volcengineapi.com?Action=DescribeLivePullToPushBandwidthData&Version=2023-01-01 { "DomainList": [ "push.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": [ "push.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. | 内部服务超时,请联系技术支持。 |
undefined | undefined | undefined | undefined |
视频直播提供了配套的开发工具集 SDK,支持多种编程语言,帮助您更方便的调用 API。