最近更新时间:2023.09.25 21:09:57
首次发布时间:2022.01.17 10:33:21
获取当前账号下,已经创建的拉流转推任务列表。
说明
该接口数据历史版本 API,我们计划于 2023 年 12 月 25 日停止对其进行维护,并于 2024 年 3 月 25 日下线文档,建议您使用新版获取拉流转推任务列表接口。
请求频率:单用户请求频率限制为 15 次/秒。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | ListPullToPushTask | 接口名称。当前 API 的名称为 ListPullToPushTask 。 |
Version | String | 是 | 2020-08-01 | 接口版本。当前 API 的版本为 2020-08-01 。 |
Page | Integer | 否 | 1 | 页码,默认值为 1,取值范围为正整数 |
Size | Integer | 否 | 20 | 每页数量,取值范围为 [1,500],默认值为 20 |
Title | String | 否 |
| 任务名称。不区分大小写,支持模糊查询。 |
下表仅列出本接口特有的返回参数。更多信息请见返回结构。
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
List | Array of List | - | 任务列表 |
Pagination | Object of Pagination | - | 分页数量信息 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Title | String | task001 | 任务名称 |
TaskId | String | fde6aa0281d*******9a6e24236 | 任务 ID,任务的唯一标识 |
StartTime | String | 2022-04-01T00:00:00+08:00 | 任务开始时间,RFC3339 格式的 UTC 时间,单位为 s |
EndTime | String | 2022-04-02T00:00:00+08:00 | 任务结束时间,RFC3339 格式的 UTC 时间,单位为 s |
CallbackURL | String | http://example.mtime.cn/live/example/callbackapi | 回调地址,用于接收回调消息 |
Type | Integer |
| 拉流来源类型。支持以下 2 种取值。
|
CycleMode | Integer |
| 循环模式。当
|
DstAddr | String | rtmp://example.mtime.cn/Video/2022/02/04/mp4/190204084208765161.mp4 | 推流地址 |
SrcAddr | String | http://example.mtime.cn/Video/2003/02/04/mp4/190204084208765161.mp4 | 直播拉流地址。拉流来源类型 type 为直播 0 时返回 |
SrcAddrS | Array of String | ["http://example.mtime.cn/Video/2003/02/04/mp4/190204084208765161.mp4"] | 点播播放地址列表。拉流来源类型 type 为点播 1 时返回 |
Status | String |
| 任务状态。支持以下取值。
|
DstAddrType | Integer |
| 推流地址类型。
|
Watermark | Object of Watermark | 水印信息 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
PageCur | Integer | 1 | 当前任务所在分页 |
PageSize | Integer | 10 | 每页结果数量 |
PageTotal | Integer | 108 | 分页的总量 |
TotalCount | Integer | 1073 | 返回任务总条数 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Picture | String |
| 水印图片字符串,图片最大 2MB,最小 100Bytes,最大分辨率为 1080×1080。图片 Data URL 格式为:
|
RelativePosX | Float | 0.1 | 水平偏移,表示水印左侧边与转码流画面左侧边之间的距离,使用相对比率,取值范围为 [0,1) |
RelativePosY | Float | 0.1 | 垂直偏移,表示水印顶部边与转码流画面顶部边之间的距离,使用相对比率,取值范围为 [0,1) |
Ratio | Float | 0.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 } } }
访问公共错误码获取详细信息。