文档首页/视频直播 Live/云直播API参考/拉流管理/查询直播拉流转推任务 - ListPullTasks
更新时间:2026-03-26 GMT+08:00

查询直播拉流转推任务 - ListPullTasks

功能介绍

查询直播拉流转推任务。

调用方法

请参见如何调用API

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,需具备如下身份策略权限。

    授权项

    访问级别

    资源类型(*为必须)

    条件键

    别名

    依赖的授权项

    live:stream:listPullTask

    Read

    -

    -

    -

    -

URI

GET /v1/{project_id}/pull/stream/task

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,获取方法请参考获取项目ID

表2 Query参数

参数

是否必选

参数类型

描述

region

String

参数解释

任务所在区域

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

offset

Integer

参数解释

偏移量

约束限制

不涉及

默认取值

不涉及

取值范围:

0~2147483647

limit

Integer

参数解释

每页记录数

约束限制

不涉及

默认取值

不涉及

取值范围:

1~100

task_id

String

参数解释

任务ID

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token,使用Token鉴权方式时必填。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

task_infos

Array of LivePullTaskInfo objects

参数解释

直播拉流任务列表

request_id

String

参数解释

请求ID

取值范围

不涉及

total

Integer

参数解释

总条目数

取值范围:

0~10000

表5 LivePullTaskInfo

参数

参数类型

描述

task_id

String

参数解释

任务ID

取值范围

不涉及

status

String

参数解释

任务状态

取值范围

不涉及

create_time

String

参数解释

创建时间

取值范围

不涉及

region

String

参数解释

任务执行区域

取值范围

不涉及

source_type

String

参数解释

拉流源类型

取值范围

  • PullLivePushLive:直播

  • PullVodPushLive:视频地址路径

source_urls

Array of strings

参数解释

拉流源URL

domain

String

参数解释

直播推流域名

取值范围

字符长度为[1-255]位

app_name

String

参数解释

应用名称

取值范围

字符长度为[1-128]位

stream_name

String

参数解释

流名称

取值范围

字符长度为[1-512]位

push_args

String

参数解释

推流参数

取值范围

不涉及

destination_url

String

参数解释

完整的目标URL。

取值范围

  • 字符长度为[0,2048]位。

  • 如果指定此参数,domain、app_name和stream_name需要传入空字符串或不传。

start_time

String

参数解释

任务启动时间,时间格式:"2006-01-02T15:04:05Z"。

取值范围

不涉及

end_time

String

参数解释

任务结束时间,时间格式:"2006-01-02T15:04:05Z"。

取值范围

不涉及

callback_events

Array of strings

参数解释

要回调的事件列表(不填则回调全部)

  • TaskStart:任务启动回调

  • TaskExit:任务停止回调

  • VodSourceFileStart:仅PullVodPushLive可用,文件启动切换

  • VodSourceFileFinish:仅PullVodPushLive可用,文件播放完毕

  • ResetTaskConfig:仅PullVodPushLive可用,任务更新

  • TaskAlarm:用于告警事件通知

callback_url

String

参数解释

回调接收地址

取值范围

不涉及

backup_source_type

String

参数解释

备源的类型

  • 仅当source_type为PullVodPushLive生效。

  • 主直播源拉流中断时,自动使用备源进行拉流。

取值范围

PullLivePushLive:直播

backup_source_urls

Array of strings

参数解释

备源URL。数组长度为[0,30],且仅当source_type为PullVodPushLive生效。

vod_loop_time

String

参数解释

视频播放循环次数,仅当source_type为PullVodPushLive生效。

取值范围

  • -1:无限循环,以结束时间为准。

  • N:按文件列表播放N轮,以播放完成和结束时间先到的为准。

  • 不传、为空("")时,按缺省值生效。

vod_start_video_index

Integer

参数解释

播放文件索引,从0开始表示第一个文件,最大值 len(source_urls)-1。仅当source_type为PullVodPushLive生效。

取值范围:

0~8192

vod_start_video_time

Integer

参数解释

指定从上述指定文件的第几秒开始播放,仅当source_type为PullVodPushLive生效。

取值范围:

0~2100000000

vod_refresh_type

String

参数解释

修改任务时文件切换方式

取值范围

  • immediate_new_source:立即播放新的拉流源内容

  • continue_from_file_start:从上次断流url文件重新开始推流

  • continue_from_break_point:从上次断流url文件断流位置开始推流(续上)

状态码:400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

request_id

String

请求id

状态码:404

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

request_id

String

请求id

请求示例

GET https://{endpoint}/v1/{project_id}/pull/stream/task?region=cn-north-4&task_id=xxxxxx

响应示例

状态码:200

查询直播拉流转推任务成功

{
  "request_id" : "85968475-e92f-42db-a754-08e627b6d8dd",
  "total" : 1,
  "task_infos" : [ {
    "task_id" : "7864b3dc-e92f-42db-a754-08e627b6d8dd",
    "status" : "suspend",
    "create_time" : "2018-05-19T10:00:00Z",
    "region" : "cn-north-4",
    "source_type" : "PullLivePushLive",
    "source_urls" : [ "rtmp://play.example.huawei.com/live/stream1" ],
    "domain" : "publish.example.huawei.com",
    "app_name" : "live",
    "stream_name" : "test",
    "start_time" : "2018-05-19T18:00:00Z",
    "end_time" : "2018-05-19T21:00:00Z",
    "push_args" : "arg1=value1",
    "destination_url" : "",
    "callback_events" : [ "TaskStart", "TaskExit", "TaskAlarm" ],
    "callback_url" : "callback.example.com",
    "backup_source_type" : "PullLivePushLive",
    "backup_source_urls" : [ "rtmp://play.example.huawei.com/live/stream1_bak" ]
  } ]
}

状态码:400

查询直播拉流转推任务失败

{
  "error_code" : "LIVE.100011001",
  "error_msg" : "Request Illegal",
  "request_id" : "85968475-e92f-42db-a754-08e627b6d8dd"
}

状态码:404

任务不存在

{
  "error_code" : "LIVE.100011001",
  "error_msg" : "Request Illegal",
  "request_id" : "85968475-e92f-42db-a754-08e627b6d8dd"
}

状态码

状态码

描述

200

查询直播拉流转推任务成功

400

查询直播拉流转推任务失败

404

任务不存在

错误码

请参见错误码