You need to enable JavaScript to run this app.
导航
获取拉流转推任务列表
最近更新时间:2023.10.12 17:39:57首次发布时间:2022.01.17 10:33:21

获取当前账号下,已经创建的拉流转推任务列表。

说明

该接口属于历史版本 API,我们计划于 2023 年 12 月 25 日停止对其进行维护,并于 2024 年 3 月 25 日下线文档,建议您使用新版获取拉流转推任务列表接口。

注意事项

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

请求说明

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

请求参数

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

Query

参数类型是否必选示例值描述
ActionStringListPullToPushTask接口名称。当前 API 的名称为 ListPullToPushTask
VersionString2020-08-01接口版本。当前 API 的版本为 2020-08-01
PageInteger1页码,默认值为 1,取值范围为正整数
SizeInteger20每页数量,取值范围为 [1,500],默认值为 20

Title

String

doc

任务名称。不区分大小写,支持模糊查询。
例如,title 取值为 doc 时,则返回任务名称为 docspacedocsDOC 等包含 doc 关键词的任务列表

返回参数

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

参数类型示例值描述
ListArray of List-任务列表
PaginationObject of Pagination-分页数量信息

List

参数类型示例值描述
TitleStringtask001任务名称
TaskIdStringfde6aa0281d*******9a6e24236任务 ID,任务的唯一标识
StartTimeString2022-04-01T00:00:00+08:00任务开始时间,RFC3339 格式的 UTC 时间,单位为 s
EndTimeString2022-04-02T00:00:00+08:00任务结束时间,RFC3339 格式的 UTC 时间,单位为 s
CallbackURLStringhttp://example.mtime.cn/live/example/callbackapi回调地址,用于接收回调消息

Type

Integer

0

拉流来源类型。支持以下 2 种取值。

  • 0:直播;
  • 1:点播。

CycleMode

Integer

-1

循环模式。当 "Type":0 时,该参数无效,当 "Type":1 时,参数取值及含义如下所示。

  • -1:表示无限循环,至任务结束;
  • ≥1:取值表示循环的次数。
DstAddrStringrtmp://example.mtime.cn/Video/2022/02/04/mp4/190204084208765161.mp4推流地址
SrcAddrStringhttp://example.mtime.cn/Video/2003/02/04/mp4/190204084208765161.mp4直播拉流地址。拉流来源类型 type 为直播 0 时返回
SrcAddrSArray of String["http://example.mtime.cn/Video/2003/02/04/mp4/190204084208765161.mp4"]点播播放地址列表。拉流来源类型 type 为点播 1 时返回

Status

String

未开始

任务状态。支持以下取值。

  • 停用;
  • 未开始;
  • 生效中;
  • 已结束。

DstAddrType

Integer

1

推流地址类型。

  • 1:非第三方;
  • 2:第三方。
WatermarkObject of Watermark水印信息

Pagination

参数类型示例值描述
PageCurInteger1当前任务所在分页
PageSizeInteger10每页结果数量
PageTotalInteger108分页的总量
TotalCountInteger1073返回任务总条数

Watermark

参数类型示例值描述

Picture

String

data:image/png;base64,iVBORw0KGg\*\*\*\*mCC

水印图片字符串,图片最大 2MB,最小 100Bytes,最大分辨率为 1080×1080。图片 Data URL 格式为:data:[<mediatype>];[base64],<data>

  • mediatype:图片类型,支持 png、jpg、jpeg 格式;
  • data:base64 编码的图片字符串。
    例如,data:image/png;base64,iVBORw0KGg****mCC
RelativePosXFloat0.1水平偏移,表示水印左侧边与转码流画面左侧边之间的距离,使用相对比率,取值范围为 [0,1)
RelativePosYFloat0.1垂直偏移,表示水印顶部边与转码流画面顶部边之间的距离,使用相对比率,取值范围为 [0,1)
RatioFloat0.1水印宽度,占直播原始画面宽度百分比,支持精度,小数点后两位

示例

请求示例

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

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202112311457440101742350380352BCC7",
        "Action": "ListPullToPushTask",
        "Version": "2020-08-01",
        "Service": "live",
        "Region": "cn-north-1"
    },
    "Result": {
        "List": [
            {
                "CallbackURL": "",
                "CycleMode": -1,
                "DstAddr": "rtmp://example.org/Video/2022/02/04/mp4/190204084208765161.mp4",
                "EndTime": "2022-01-01T23:44:32+08:00",
                "SrcAddr": "http://example.org/Video/2003/02/04/mp4/190204084208765161.mp4",
                "SrcAddrS": [],
                "DstAddrType": 2,
                "StartTime": "2021-12-31T22:44:23+08:00",
                "Status": "未开始",
                "TaskId": "8fde6aa0281d9f6e15e6059a6e242365",
                "Title": "sutest007",
                "Type": 0
            }
        ],
        "Pagination": {
            "PageCur": 1,
            "PageSize": 10,
            "PageTotal": 108,
            "TotalCount": 1073
        }
    }
}

错误码

访问公共错误码获取详细信息。