创建直播拉流转推任务 - CreatePullTask

project_id

是

String

项目ID，获取方法请参考获取项目ID。

X-Auth-Token

否

String

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

region

否

String

参数解释：

任务执行区域

约束限制：

如果指定推流域名，则region需要与推流域名直播源站一致，缺省为租户归属region

取值范围：

字符长度为[1,64]位

默认取值：

不涉及

source_type

是

String

参数解释：

拉流源类型

约束限制：

不涉及

取值范围：

• PullLivePushLive：直播

• PullVodPushLive：视频地址路径

默认取值：

不涉及

source_urls

是

Array of strings

参数解释：

拉流源URL

约束限制：

• 当source_type为PullLivePushLive时，只能填写一个URL。

• 当source_type为PullVodPushLive时，可以指定多个视频地址路径URL。

• 数组长度为[1,30]。

domain

否

String

参数解释：

直播推流域名

约束限制：

不涉及

取值范围：

字符长度为[0-255]位

默认取值：

不涉及

app_name

否

String

参数解释：

应用名称

约束限制：

不涉及

取值范围：

字符长度为[0-128]位

默认取值：

不涉及

stream_name

否

String

参数解释：

流名称

约束限制：

不涉及

取值范围：

字符长度为[0-512]位

默认取值：

不涉及

push_args

否

String

参数解释：

推流参数

约束限制：

不涉及

取值范围：

字符长度为[0,2048]位

默认取值：

不涉及

destination_url

否

String

参数解释：

完整的目标URL

约束限制：

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

取值范围：

字符长度为[0,2048]位

默认取值：

不涉及

start_time

否

String

参数解释：

任务启动时间

约束限制：

• 时间格式："2006-01-02T15:04:05Z"

• 必须小于结束时间，缺省为当前时间

取值范围：

不涉及

默认取值：

不涉及

end_time

否

String

参数解释：

任务结束时间

约束限制：

• 时间格式："2006-01-02T15:04:05Z"

• 必须大于开始时间，至多为开始时间+7天

取值范围：

不涉及

默认取值：

不涉及

vod_loop_time

否

String

参数解释：

视频播放循环次数

约束限制：

仅当source_type为PullVodPushLive生效

取值范围：

• -1：无限循环，以结束时间为准。

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

• 不传、为空（""）时按缺省值生效。

默认取值：

-1

vod_refresh_type

否

String

参数解释：

视频地址路径更新source_urls后的生效形式

约束限制：

仅当source_type为PullVodPushLive生效

取值范围：

• immediate_new_source：立即播放新的文件源

• continue_from_file_start：从上次断流URL文件重新播放（更新任务时有效）

• continue_from_break_point：从上次断流URL文件断流位置重新播放（更新任务时有效）

默认取值：

immediate_new_source

vod_start_video_index

否

Integer

参数解释：

播放文件索引，从0开始表示第一个文件

约束限制：

仅当source_type为PullVodPushLive生效，最大值 len(source_urls)-1

默认取值：

0

取值范围：

0~2147483647

vod_start_video_time

否

Integer

参数解释：

指定从上述指定文件的第几秒开始播放

约束限制：

仅当source_type为PullVodPushLive生效

默认取值：

0

取值范围：

0~2147483647

backup_source_type

否

String

参数解释：

备源的类型

约束限制：

• 仅当source_type为PullVodPushLive生效。

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

取值范围：

PullLivePushLive：直播

默认取值：

不涉及

backup_source_urls

否

Array of strings

参数解释：

备源URL

约束限制：

数组长度为[0,30]，且仅当source_type为PullVodPushLive生效

callback_events

否

Array of strings

参数解释：

要回调的事件列表（不填则回调全部）

• TaskStart：任务启动回调

• TaskExit：任务停止回调

• VodSourceFileStart：仅PullVodPushLive可用，文件启动切换

• VodSourceFileFinish：仅PullVodPushLive可用，文件播放完毕

• ResetTaskConfig：仅PullVodPushLive可用，任务更新

• TaskAlarm：用于告警事件通知

约束限制：

不涉及

callback_url

否

String

参数解释：

回调接收地址

约束限制：

不涉及

取值范围：

字符长度为[0,2048]位

默认取值：

不涉及

task_id

String

参数解释：

任务ID

取值范围：

不涉及

request_id

String

参数解释：

请求ID

取值范围：

不涉及

error_code

String

错误码

error_msg

String

错误描述

request_id

String

请求id

200

创建拉流转推任务成功

400

创建拉流转推任务失败