ListPullRecordTask - 查询直播录制任务--视频直播-火山引擎

文档中心

立即注册

导航

ListPullRecordTask - 查询直播录制任务

最近更新时间：2025.04.22 20:43:40首次发布时间：2023.07.10 21:02:29

本接口用于查询当前账号下创建的直播录制任务列表，支持按分页、域名、应用名称、流名称等条件进行组合查询。通过该接口，您可以获取任务的具体信息，如录制时段、任务状态等，帮助您跟踪录制进度、监控任务状态，并支持后续资源管理工作。

注意事项

请求频率：单用户请求频率限制为 50 次/秒。
计费说明：：本接口用于查询已创建的录制任务记录，不涉及实时录制或数据存储操作，不会产生费用。

请求说明

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

调试

API Explorer

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

去调试

请求参数

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

Query

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

Body

参数	类型	是否必选	示例值	描述
PageNum	Integer	是	`1`	查询数据的页码，默认为 `1`，表示查询第一页的数据，取值范围为正整数。
PageSize	Integer	是	`5`	每页显示的数据条数，默认为 `20`，取值范围为 `[1,500]`。
App	String	否	`live`	应用名称，取值与直播流地址的 `AppName` 字段取值相同，用来指定待更新的录制配置，默认为空。您可以调用 ListVhostRecordPresetV2 接口获取 `App` 取值。
Domain	String	否	`push.example.com`	直播流使用的推流域名或拉流域名。您可以调用 ListDomainDetail 接口或在视频直播控制台的域名管理页面，查看直播流使用的域名。
Stream	String	否	`example_stream`	流名称，取值与直播流地址的 `StreamName` 字段取值相应，用来指定待查询的录制任务，默认为空。您可以调用 ListVhostRecordPresetV2 接口获取 `Stream` 取值。
Vhost	String	否	`push.example.com`	域名空间，即直播流地址的域名所属的域名空间。您可以调用 ListDomainDetail 接口或在视频直播控制台的域名管理页面，查看需要录制的直播流使用的域名所属的域名空间。

返回参数

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

参数	类型	示例值	描述
List	Array of List	`-`	直播录制任务列表。
Pagination	Object of Pagination	`-`	查询结果的分页信息。

List

参数	类型	示例值	描述
TaskId	String	`f831f3b0dc******aa4dcf7621`	任务 ID，任务的唯一标识。
StartTime	String	`2023-06-30T15:04:05+08:00`	录制的开始时间，RFC3339 格式的 UTC 时间，精度为秒。
EndTime	String	`2023-06-30T15:05:05+08:00`	录制的结束时间，RFC3339 格式的 UTC 时间，精度为秒。
Vhost	String	`push.example.com`	域名空间名称。
Domain	String	`push.example.com`	推流域名或拉流域名。
App	String	`Live`	应用名称。
Stream	String	`example_stream`	流名称。
Status	String	`已结束`	录制任务的状态，取值及含义如下所示。 `停用`：录制任务已被停止； `未开始`：录制任务未到录制开始时间； `生效中`：录制任务正在录制； `已结束`：录制已结束。

Pagination

参数	类型	示例值	描述
PageCur	Integer	`1`	当前所在分页的页码。
PageSize	Integer	`2`	每页显示的数据条数。
PageTotal	Integer	`43`	查询结果的数据总页数。
TotalCount	Integer	`86`	查询结果的数据总条数。

请求示例

POST https://live.volcengineapi.com?Action=ListPullRecordTask&Version=2023-01-01
{
    "PageNum": 1,
    "PageSize": 2
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230707165315BAA447BA0E1B31B128B3",
        "Action": "ListPullRecordTask",
        "Version": "2023-01-01",
        "Service": "live",
        "Region": "cn-north-1"
    },
    "Result": {
        "List": [
            {
                "App": "Live",
                "Domain": "live.example.push.com",
                "EndTime": "2023-07-07T16:19:24+08:00",
                "StartTime": "2023-07-07T16:16:07+08:00",
                "Status": "已结束",
                "Stream": "livestream001",
                "TaskId": "f831f3b0dc******aa4dcf7621",
                "Vhost": "live.example.push.com"
            },
            {
                "App": "Live",
                "Domain": "live.example.push.com",
                "EndTime": "2023-07-04T12:05:27+08:00",
                "StartTime": "2023-07-04T12:00:45+08:00",
                "Status": "已结束",
                "Stream": "livestream002",
                "TaskId": "8f163****c1afc24a29b",
                "Vhost": "live.example.push.com"
            }
        ],
        "Pagination": {
            "PageCur": 1,
            "PageSize": 2,
            "PageTotal": 43,
            "TotalCount": 86
        }
    }
}

错误码

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

状态码	错误码	错误信息	说明
200	CommonErr	-	未分类错误。建议重试，如果仍返回该错误码，请联系技术支持。
400	InvalidParam	-	输入的参数无效或不符合要求，请参照请求参数说明进行检查。
400	InvalidParam.BindError	Request parameter error, please check input data	参数未通过校验，请检查参数类型是否正确。
403	RequestForbidden	-	请求被拒绝，当前账号下无请求的资源（域名空间、域名、应用、配置模版、证书）。
403	RequestForbidden.AccountIDNotAllow	this AccountID does not have permission to access the corresponding resource, please check the request parameters	请求被拒绝，当前账号下无请求的资源（域名空间、域名、应用、配置模版、证书）。
403	RequestForbidden.BillingStatus	Billing status is not available for the AccountID, please activate the service or recharge.	未开通视频直播服务或账号欠费，造成账单不可用，请检查服务开通情况和账号欠费情况。
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。