DescribeLivePullToPushData - 查询拉流转推时长用量--视频直播-火山引擎

文档中心

立即注册

导航

DescribeLivePullToPushData - 查询拉流转推时长用量

最近更新时间：2025.04.22 19:10:54首次发布时间：2023.09.25 14:35:35

调用 DescribeLivePullToPushData 接口，查询指定时间范围内产生的所有拉流转推任务进行时长用量。

注意事项

计费说明：拉流转推费用请参见拉流转推计费。
请求频率：单用户请求频率限制为 30 次/秒。
数据延迟：时间粒度为 60 秒时，数据延迟为 5 分钟；其他时间粒度时，数据延迟为 15 分钟。

请求说明

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

调试

API Explorer

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

去调试

请求参数

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

Query

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

Body

参数	类型	是否必选	示例值	描述
GroupList	Array of String	否	`["group001"]`	拉流转推任务群组列表，默认为空，表示查询所有拉流转推任务群组的时长用量。
StartTime	String	是	`2022-03-07T00:00:00+08:00`	查询的开始时间，RFC3339 格式的时间戳，精度为秒。
EndTime	String	是	`2022-03-08T00:00:00+08:00`	查询的结束时间，RFC3339 格式的时间戳，精度为秒。
Aggregation	Integer	否	`3600`	数据聚合的时间粒度，单位为秒，支持的时间粒度如下所示。 `60`：1 分钟。时间粒度为 1 分钟时，单次查询最大时间跨度为 1 天，历史查询时间范围为 366 天； `3600`：1 小时。时间粒度为 1 小时时，单次查询时间跨度为 93 天，历史查询时间范围为 366 天； `86400`：（默认值）1 天。时间粒度为 1 天时，单次查询最大时间跨度为 93 天，历史查询时间范围为 366 天。
DetailField	Array of String	否	`["Group"]`	数据拆分的维度，默认为空表示不按维度进行数据拆分，当前接口仅支持填写 `Group` 表示按查询的任务群组为维度进行数据拆分。说明配置数据拆分的维度时，对应的维度参数传入多个值时才会返回按此维度拆分的数据。例如，配置按 Group 进行数据拆分时， GroupList 传入多个 Group 值时，才会返回按 Group 拆分的数据。
App	String	否	`live`	应用名称，取值与直播流地址中 AppName 字段取值相同。支持由大小写字母（A - Z、a - z）、数字（0 - 9）、下划线（_）、短横线（-）和句点（.）组成，长度为 1 到 30 个字符。说明查询流粒度数据时，需同时传入 `App` 和 `Stream`。
Stream	String	否	`example_stream`	流名称，取值与直播流地址中 StreamName 字段取值相同。支持由大小写字母（A - Z、a - z）、数字（0 - 9）、下划线（_）、短横线（-）和句点（.）组成，长度为 1 到 100 个字符。说明查询流粒度数据时，需同时传入 `App` 和 `Stream`。

返回参数

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

参数	类型	示例值	描述
StartTime	String	`2022-03-07T00:00:00+08:00`	查询的开始时间，RFC3339 格式的时间戳，精度为秒。
EndTime	String	`2022-03-08T00:00:00+08:00`	查询的结束时间，RFC3339 格式的时间戳，精度为秒。
Aggregation	Integer	`86400`	数据聚合的时间粒度，单位为秒。 `60`：1 分钟； `3600`：1 小时； `86400`：1 天。
DetailField	Array of String	`["Group"]`	数据拆分的维度，当前接口仅支持按 Group 即拉流转推任务群组维度进行数据拆分。
TotalDuration	Float	`6`	当前查询条件下的拉流转推总时长，单位为分钟。
PullToPushDataList	Array of PullToPushDataList	`-`	所有时间粒度的数据。
PullToPushDetailDataList	Array of PullToPushDetailDataList	`-`	按维度拆分后的数据。
App	String	`live`	查询流粒度数据时的应用名称。
Stream	String	`example_stream`	查询流粒度数据时的流名称。
GroupList	Array of String	`["group001"]`	拉流转推任务群组。

PullToPushDataList

参数	类型	示例值	描述
TimeStamp	String	`2022-03-07T00:00:00+08:00`	数据按时间粒度聚合时，每个时间粒度的开始时间，RFC3339 格式的时间戳，精度为秒。
Value	Float	`99`	当前数据聚合时间粒度内的拉流转推总时长，单位为分钟。

PullToPushDetailDataList

参数	类型	示例值	描述
Group	String	`group001`	按任务群组维度进行数据拆分时的群组信息。
TotalDuration	Float	`99`	按维度进行数据拆分后，当前维度的拉流转推总时长，单位分钟。
PullToPushDataList	Array of PullToPushDataList	`-`	按维度进行数据拆分后，当前维度下所有时间粒度的数据。

请求示例

POST https://live.volcengineapi.com?Action=DescribeLivePullToPushData&Version=2023-01-01
{
    "GroupList": [
        "group001",
        "group002"
    ],
    "StartTime": "2022-03-07T00:00:00+08:00",
    "EndTime": "2022-03-08T00:00:00+08:00",
    "Aggregation": 86400,
    "DetailField": [
        "Group"
    ]
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "201806041104200100****",
        "Action": "DescribeLivePullToPushData",
        "Version": "2023-01-01",
        "Service": "live",
        "Region": "cn-north-1"
    },
    "Result": {
        "GroupList": [
            "group001",
            "group002"
        ],
        "StartTime": "2022-03-07T00:00:00+08:00",
        "EndTime": "2022-03-08T00:00:00+08:00",
        "Aggregation": 86400,
        "DetailField": [
            "Group"
        ],
        "TotalDuration": 6,
        "PullToPushDataList": [
            {
                "TimeStamp": "2022-03-07T00:00:00+08:00",
                "Value": 99
            }
        ],
        "PullToPushDetailDataList": [
            {
                "Group": "group001",
                "TotalDuration": 6,
                "PullToPushDataList": [
                    {
                        "TimeStamp": "2022-03-07T00:00:00+08:00",
                        "Value": 99
                    }
                ]
            }
        ]
    }
}

错误码

下表仅列出本接口特有的错误码。更多信息请参见公共错误码获取详细信息。

状态码	错误码	错误信息	说明
400	InvalidParam	-	输入的参数无效或不符合要求，请参照请求参数说明进行检查。
403	RequestForbidden	-	请求被拒绝，当前账号下无请求的资源（域名空间、域名、应用、配置模版、证书）。
500	InternalError	an internal error occurred, please contact the administrator.	出现内部错误，请联系技术支持。

服务端 SDK

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