修改直播拉流转推任务 - ModifyPullTask
功能介绍
修改直播拉流转推任务,仅当source_type为PullVodPushLive的任务生效
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
请求参数
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
X-Auth-Token | 否 | String | 用户Token,使用Token鉴权方式时必填。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
task_id | 是 | String | 参数解释: 任务ID 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
status | 否 | String | 参数解释: 任务状态 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
source_urls | 否 | Array of strings | 参数解释: 拉流源URL 约束限制: 数组长度为[1,30] |
vod_loop_time | 否 | String | 参数解释: 视频播放循环次数 约束限制: 仅当source_type为PullVodPushLive生效 取值范围: 默认取值: -1 |
vod_refresh_type | 否 | String | 参数解释: 视频地址路径更新source_urls后的生效形式 约束限制: 仅当source_type为PullVodPushLive生效 取值范围: 默认取值: immediate_new_source |
vod_start_video_index | 否 | Integer | 参数解释: 播放文件索引,从0开始表示第一个文件,最大值 len(source_urls)-1 约束限制: 仅当source_type为PullVodPushLive生效 默认取值: 0 取值范围: 0~2147483647 |
start_time | 否 | String | 参数解释: 任务启动时间 约束限制: 取值范围: 不涉及 默认取值: 不涉及 |
end_time | 否 | String | 参数解释: 任务结束时间 约束限制: 取值范围: 不涉及 默认取值: 不涉及 |
vod_start_video_time | 否 | Integer | 参数解释: 指定从上述指定文件的第几秒开始播放 约束限制: 仅当source_type为PullVodPushLive生效 默认取值: 0 取值范围: 0~2147483647 |
callback_events | 否 | Array of strings | 参数解释: 要回调的事件列表(不填则回调全部) 约束限制: 不涉及 |
响应参数
状态码:200
参数 | 参数类型 | 描述 |
|---|---|---|
task_id | String | 参数解释: 任务ID 取值范围: 不涉及 |
request_id | String | 参数解释: 请求ID 取值范围: 不涉及 |
状态码:400
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 错误码 |
error_msg | String | 错误描述 |
request_id | String | 请求id |
请求示例
PUT https://{endpoint}/v1/{project_id}/pull/stream/task
{
"task_id" : "xxxxxxxxxx",
"status" : "pause",
"source_urls" : [ "rtmp://play.example.huawei.com/live/stream1" ],
"start_time" : "2018-05-19T18:00:00Z",
"end_time" : "2018-05-19T21:00:00Z",
"vod_loop_time" : "-1",
"vod_refresh_type" : "immediate_new_source",
"vod_start_video_index" : 0,
"vod_start_video_time" : 0,
"callback_events" : [ "TaskStart", "VodSourceFileStart", "VodSourceFileFinish", "ResetTaskConfig", "TaskExit", "TaskAlarm" ]
} 响应示例
状态码:200
修改直播拉流转推任务成功
{
"task_id" : "7864b3dc-e92f-42db-a754-08e627b6d8dd",
"request_id" : "85968475-e92f-42db-a754-08e627b6d8dd"
} 状态码:400
修改直播拉流转推任务失败
{
"error_code" : "LIVE.100011001",
"error_msg" : "Request Illegal",
"request_id" : "85968475-e92f-42db-a754-08e627b6d8dd"
} 状态码
状态码 | 描述 |
|---|---|
200 | 修改直播拉流转推任务成功 |
400 | 修改直播拉流转推任务失败 |
错误码
请参见错误码。

