DescribeLivePullToPushBandwidthData - 查询拉流转推带宽用量--视频直播-火山引擎

文档中心

立即注册

导航

DescribeLivePullToPushBandwidthData - 查询拉流转推带宽用量

最近更新时间：2024.12.09 11:16:50首次发布时间：2023.09.25 14:35:35

调用 DescribeLivePullToPushBandwidthData 接口，查询指定时间范围内拉流转推至第三方域名时产生的拉流转推带宽用量。

注意事项

计费说明：拉流转推至第三方时的转推带宽计费请参见拉流转推计费。
请求频率：单用户请求频率限制为 30 次/秒。
数据延迟：数据延迟为 15 分钟。
数据进制：带宽数据统计进制为 1000，例如，1 Mbps = 1000 Kbps。

请求说明

请求方式：POST
请求地址：https://live.volcengineapi.com?Action=DescribeLivePullToPushBandwidthData&Version=2023-01-01

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`DescribeLivePullToPushBandwidthData`	接口名称。当前 API 的名称为 `DescribeLivePullToPushBandwidthData`。
Version	String	是	`2023-01-01`	接口版本。当前 API 的版本为 `2023-01-01`。

Body

参数	类型	是否必选	示例值	描述
GroupList	Array of String	否	`["group001","group002"]`	拉流转推任务群组列表，默认为空，表示查询所有拉流转推任务群组的带宽用量。
StartTime	String	是	`2021-04-13T00:00:00+08:00`	查询的开始时间，RFC3339 格式的时间戳，精度为秒。
EndTime	String	是	`2021-04-14T00:00:00+08:00`	查询的结束时间，RFC3339 格式的时间戳，精度为秒。
Aggregation	Integer	否	`300`	数据聚合的时间粒度，单位为秒，支持的时间粒度如下所示。 `300`：（默认值）5 分钟。时间粒度为 5 分钟时，单次查询最大时间跨度为 31 天，历史查询时间范围为 366 天； `3600`：1 小时。时间粒度为 1 小时时，单次查询最大时间跨度为 93 天，历史查询时间范围为 366 天； `86400`：1 天。时间粒度为 1 天时，单次查询最大时间跨度为 93 天，历史查询时间范围为 366 天。
DetailField	Array of String	否	`["Group"]`	数据拆分的维度，默认为空表示不按维度进行数据拆分，当前支持按 `Group` 维度进行拆分。说明配置数据拆分的维度时，对应的维度参数传入多个值时才会返回按此维度拆分的数据。例如，配置按 Group 进行数据拆分时， GroupList 传入多个 Group 值时，才会返回按 Group 拆分的数据。

返回参数

下表仅列出本接口特有的返回参数。更多信息请见返回结构。

参数	类型	示例值	描述
GroupList	Array of String	`["group001","group002"]`	拉流转推任务群组列表。
StartTime	String	`2021-04-13T00:00:00+08:00`	查询的开始时间，RFC3339 格式的时间戳，精度为秒。
EndTime	String	`2021-04-14T00:00:00+08:00`	查询的结束时间，RFC3339 格式的时间戳，精度为秒。
Aggregation	Integer	`300`	数据聚合的时间粒度，单位为秒。 `300`：5 分钟； `3600`：1 小时； `86400`：1 天。
DetailField	Array of String	`["Group"]`	数据拆分的维度。
PeakUpBandwidth	Float	`12`	当前查询条件下的拉流转推峰值带宽，单位为 Mbps。
BandwidthDataList	Array of BandwidthDataList	`-`	所有时间粒度的数据。
BandwidthDetailDataList	Array of BandwidthDetailDataList	`-`	按维度拆分后的数据。说明当配置了数据拆分的维度时，对应的维度参数传入多个值才会返回按维度拆分的数据。

BandwidthDataList

参数	类型	示例值	描述
TimeStamp	String	`2022-04-13T00:00:00+08:00`	数据按时间粒度聚合时，每个时间粒度的开始时间，RFC3339 格式的时间戳，精度为秒。
UpBandwidth	Float	`12.0`	当前数据聚合时间粒度内的拉流转推峰值带宽，单位为 Mbps。

BandwidthDetailDataList

参数	类型	示例值	描述
Group	String	`group001`	按任务群组维度进行数据拆分时的群组信息。
DstAddrType	String	`Live`	按推流地址类型维度进行数据拆分时的地址类型信息。
PeakUpBandwidth	Float	`12.0`	查询时间范围内的维度下的拉流转推峰值带宽，单位为 Mbps。
BandwidthDataList	Array of BandwidthDataList	`-`	按维度进行数据拆分后，当前维度下所有时间粒度的数据。

请求示例

POST https://live.volcengineapi.com?Action=DescribeLivePullToPushBandwidthData&Version=2023-01-01
{
    "GroupList": [
        "group001"
    ],
    "StartTime": "2021-04-13T00:00:00+08:00",
    "EndTime": "2021-04-14T00:00:00+08:00",
    "Aggregation": 300,
    "DetailField": [
        "Group"
    ]
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "201806041104200100100232280022D30",
        "Action": "DescribeLivePullToPushBandwidthData",
        "Version": "2023-01-01",
        "Service": "live",
        "Region": "cn-north-1"
    },
    "Result": {
        "GroupList": [
            "group001"
        ],
        "StartTime": "2021-04-13T00:00:00+08:00",
        "EndTime": "2021-04-14T00:00:00+08:00",
        "Aggregation": 300,
        "DetailField": [
            "Group"
        ],
        "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.	内部服务超时，请联系技术支持。

服务端 SDK

视频直播提供了配套的开发工具集 SDK，支持多种编程语言，帮助您更方便的调用 API。