获取拉流转推任务列表--视频直播-火山引擎

文档中心

立即注册

导航

获取拉流转推任务列表

最近更新时间：2024.08.09 10:39:07首次发布时间：2023.09.25 14:34:06

调用 ListPullToPushTask 接口，分页查询拉流转推任务列表，支持以任务名称进行模糊查询。

注意事项

请求频率：单用户请求频率限制为 15 次/秒。

请求说明

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

调试

API Explorer

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

去调试

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`ListPullToPushTask`	接口名称。当前 API 的名称为 `ListPullToPushTask`。
Version	String	是	`2023-01-01`	接口版本。当前 API 的版本为 `2023-01-01`。
GroupName	String	否	`default`	群组名称。使用主账号调用时，为非必填，默认为空，表示查询所有群组的任务信息。使用子账号调用时，非必填。
Title	String	否	`doc`	拉流转推任务的名称，不区分大小写，支持模糊查询。例如，`title` 取值为 `doc` 时，则返回任务名称为 `docspace`、`docs`、`DOC` 等 title 中包含 `doc` 关键词的所有任务列表。
Page	Integer	否	`1`	查询数据的页码，默认为 1，表示查询第一页的数据。
Size	Integer	否	`20`	每页显示的数据条数，默认为 20，最大值为 500。

返回参数

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

参数	类型	示例值	描述
List	Array of List	`-`	任务列表。
Pagination	Object of Pagination	`-`	分页数量信息。

List

参数	类型	示例值	描述
Title	String	`task001`	拉流转推任务的名称。
TaskId	String	`fde6aa0281d*******9a6e24236`	任务 ID，任务的唯一标识。
StartTime	String	`2022-04-01T00:00:00+08:00`	任务的开始时间，RFC3339 格式的 UTC 时间，单位为秒。
EndTime	String	`2022-04-02T00:00:00+08:00`	任务的结束时间，RFC3339 格式的 UTC 时间，单位为秒。
CallbackURL	String	`http://example.com/live/callback`	接收拉流转推任务状态回调的地址。
Type	Integer	`0`	拉流来源类型，支持的取值及含义如下。 `0`：直播源； `1`：点播视频。
CycleMode	Integer	`-1`	点播视频文件循环播放模式，当拉流来源类型为点播视频时配置生效，参数取值及含义如下所示。 `-1`：无限次循环，至任务结束； `0`：有限次循环，循环次数以 PlayTimes 取值为准； `>0`：有限次循环，循环次数以 CycleMode 取值为准。
PlayTimes	Integer	`3`	点播视频文件循环播放次数，当 CycleMode 取值为 0 时，PlayTimes 取值将作为循环播放次数。
DstAddr	String	`rtmp://push.example.com/live/example_stream`	推流地址，即直播源或点播视频转推的目标地址。
SrcAddr	String	`http://pull.example.com/live/example_stream.mp4`	直播源的拉流地址，拉流来源类型为直播源时返回此值。
SrcAddrS	Array of String	`["https://example.com/live/stream-123.mp4"]`	点播视频播放地址列表，拉流来源类型为点播视频时返回此值。
Status	String	`未开始`	拉流转推任务的状态，支持如下取值。 `停用`； `未开始`； `生效中`； `已结束`。
DstAddrType	Integer	`1`	推流地址类型。 `1`：非第三方，即推流地址域名已添加到视频直播。 `2`：第三方，即推流地址域名未添加到视频直播。
Watermark	Object of Watermark	`-`	为拉流转推视频添加的水印配置信息。
PreDownload	Integer	`1`	是否开启点播预热，开启点播预热后，系统会自动将点播视频文件缓存到 CDN 节点上，当用户请求直播时，可以直播从 CDN 节点获取视频，从而提高直播流畅度。拉流来源类型为点播视频时，参数生效。 `0`：不开启； `1`：开启。
OffsetS	Array of Float	`[1.1]`	点播文件启播时间偏移值，单位为秒，数量与拉流地址列表中地址数量相等，缺省情况下为空表示不进行偏移。拉流来源类型为点播视频时，参数生效。
ContinueStrategy	Integer	`9`	续播策略，续播策略指转推点播视频进行直播时出现断流并恢复后，如何继续播放的策略，拉流来源类型为点播视频时参数生效，支持的取值及含义如下。 `0`：从断流处续播（默认值）； `1`：从断流处+自然流逝时长处续播。
GroupName	String	`default`	任务所属的群组名称，您可以调用 ListPullToPushGroup 获取可用的群组。说明使用主账号调用时，为非必填，默认为空表示查询所有群组的任务列表。使用子账号调用时，为必填。
VodSrcAddrs	Array of VodSrcAddrs	`-`	点播文件地址和开始播放、结束播放的时间设置。说明当 Type 为点播类型时配置生效。与 SrcAddrS 和 OffsetS 字段不可同时填写。

Pagination

参数	类型	示例值	描述
PageCur	Integer	`1`	当前任务所在分页。
PageSize	Integer	`10`	每页显示的数据条数。
PageTotal	Integer	`108`	查询结果的数据总页数。
TotalCount	Integer	`1073`	查询结果的数据总条数。

Watermark

参数	类型	示例值	描述
Picture	String	`data:image/png;base64,iVBORw0KGg****mCC`	水印图片字符串，图片最大 2MB，最小 100Bytes，最大分辨率为 1080×1080。图片 Data URL 格式为：`data:image/<mediatype>;base64,<data>`。 `mediatype`：图片类型，支持 png、jpg、jpeg 格式； `data`：base64 编码的图片字符串。例如，`data:image/png;base64,iVBORw0KGg****mCC`
RelativePosX	Float	`0.1`	水平偏移，表示水印左侧边与转码流画面左侧边之间的距离，使用相对比率，取值范围为 [0,1)。
RelativePosY	Float	`0.1`	垂直偏移，表示水印顶部边与转码流画面顶部边之间的距离，使用相对比率，取值范围为 [0,1)。
Ratio	Float	`0.1`	水印宽度占直播原始画面宽度百分比，支持精度为小数点后两位。

VodSrcAddrs

参数	类型	示例值	描述
StartOffset	Float	`65.0`	当前点播文件开始播放的时间偏移值，单位为秒。默认为空时表示开始播放时间不进行偏移。
EndOffset	Float	`80.0`	当前点播文件结束播放的时间偏移值，单位为秒，默认为空时表示结束播放时间不进行偏移。
SrcAddr	String	`https://example.com/live/stream-123.mp4`	点播文件地址。

请求示例

GET https://live.volcengineapi.com?Action=ListPullToPushTask&Version=2023-01-01&Page=1&Size=20&Title=doc

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "ListPullToPushTask",
        "Version": "2023-01-01",
        "Service": "live",
        "Region": "cn-north-1"
    },
    "Result": {
        "List": [
            {
                "Title": "task001",
                "TaskId": "fde6aa0281d*******9a6e24236",
                "StartTime": "2022-04-01T00:00:00+08:00",
                "EndTime": "2022-04-02T00:00:00+08:00",
                "CallbackURL": "http://example.com/live/callback",
                "Type": 0,
                "DstAddr": "rtmp://push.example.com/live/example_stream",
                "SrcAddr": "http://pull.example.com/live/example_stream.mp4",
                "Status": "未开始",
                "DstAddrType": 1,
                "Watermark": {
                    "Picture": "data:image/png;base64,iVBORw0KGg\\*\\*\\*\\*mCC",
                    "RelativePosX": 0.1,
                    "RelativePosY": 0.1,
                    "Ratio": 0.1
                },
                "GroupName": "default"
            }
        ],
        "Pagination": {
            "PageCur": 1,
            "PageSize": 10,
            "PageTotal": 108,
            "TotalCount": 1073
        }
    }
}

错误码

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

状态码	错误码	错误信息	说明
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。