You need to enable JavaScript to run this app.
导航
视频直播
  • 文档首页
    • /
  • 视频直播

获取拉流转推任务列表

最近更新时间：2023.11.13 13:47:54

首次发布时间：2023.09.25 14:34:06

我的收藏

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

注意事项

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

请求说明

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

请求参数

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

Query

参数类型是否必选示例值描述
ActionString是ListPullToPushTask接口名称。当前 API 的名称为 ListPullToPushTask。
VersionString是2023-01-01接口版本。当前 API 的版本为 2023-01-01。
PageInteger否1页码，默认值为 1，取值范围为正整数。
SizeInteger否20每页数量，取值范围为 [1,500]，默认值为 20。

Title

String

否

doc

任务名称。不区分大小写，支持模糊查询。
例如，title 取值为 doc 时，则返回任务名称为 docspace、docs、DOC 等包含 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=2023-01-01&Page=1&Size=20&Title=doc

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202112311457440101742350380352BCC7",
        "Action": "ListPullToPushTask",
        "Version": "2023-01-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
        }
    }
}

错误码

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

状态码错误码错误信息说明
200CommonErr-未分类错误。建议重试，如果仍返回该错误码，请联系技术支持。
400InvalidParam-输入的参数无效或不符合要求，请参照请求参数说明进行检查。
400InvalidParam.BindErrorRequest parameter error, please check input data参数未通过校验，请检查参数类型是否正确。
403RequestForbidden-请求被拒绝，当前账号下无请求的资源（域名空间、域名、应用、配置模版、证书）。
403RequestForbidden.AccountIDNotAllowthis AccountID does not have permission to access the corresponding resource, please check the request parameters请求被拒绝，当前账号下无请求的资源（域名空间、域名、应用、配置模版、证书）。
403RequestForbidden.BillingStatusBilling status is not available for the AccountID, please activate the service or recharge.未开通视频直播服务或账号欠费，造成账单不可用，请检查服务开通情况和账号欠费情况。
404ResourceNotFound-未找到资源（域名空间、域名、应用、配置模版、证书）。建议重试，如果仍返回该错误码，请联系技术支持。
500InternalErroran internal error occurred, please contact the administrator.出现内部错误，请联系技术支持。
502InternalServiceErroran internal error occurred, please contact the administrator.服务间出现错误，请联系技术支持。
502InternalServiceError.BadResponsean internal error occurred, please contact the administrator.服务间出现错误，请联系技术支持。
504InternalServiceTimeoutInternal Service is timeout. please contact the administrator.内部服务超时，请联系技术支持。