修改直播拉流转推任务 - ModifyPullTask
功能介绍
修改直播拉流转推任务，仅当source_type为PullVodPushLive的任务生效
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，当前API调用无需身份策略权限。
URI
PUT /v1/{project_id}/pull/stream/task
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID，获取方法请参考获取项目ID。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
否 |
String |
用户Token，使用Token鉴权方式时必填。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
task_id |
是 |
String |
任务id |
|
status |
否 |
String |
pause停用/enable启用 |
|
source_urls |
否 |
Array of strings |
拉流源URL |
|
vod_loop_time |
否 |
String |
缺省值”-1”。-1：无限轮播，以结束时间为准；N：按文件列表播放N轮，以播放完成和结束时间先到的为准。不传、为空（""）时按缺省值生效 |
|
vod_refresh_type |
否 |
String |
缺省值 immediate_new_source，可选 immediate_new_source、continue_from_file_start、continue_from_break_point |
|
vod_start_video_index |
否 |
Integer |
缺省值 0，指定播放文件的下标，从0开始表示第一个文件，最大值 len(source_urls)-1 |
|
start_time |
否 |
String |
任务启动时间，时间格式： "2006-01-02T15:04:05Z" 必须小于结束时间，缺省为当前时间 |
|
end_time |
否 |
String |
任务结束时间，时间格式： "2006-01-02T15:04:05Z" 必须大于开始时间，至多为开始时间+7天 |
|
vod_start_video_time |
否 |
Integer |
缺省值 0，指定从上述指定文件的第几秒开始播放 |
|
callback_events |
否 |
Array of strings |
要回调的事件列表（不填则回调全部）
|
|
src_area |
否 |
String |
回源就近区域 |
|
dst_area |
否 |
String |
转推就近区域 |
响应参数
状态码：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 |
修改直播拉流转推任务失败 |
错误码
请参见错误码。
