Help Center/ Live/ Cloud Live API Reference/ Stream Pull Management/ Modifying a Relay Task
Updated on 2026-01-07 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Modifying a Relay Task

Function

Modify the live stream pulling and pushing task so that it only takes effect for tasks where source_type is set to PullVodPushLive.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

No

String

User token. This parameter is mandatory when token authentication is used. The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

task_id

Yes

String

Task ID.

status

No

String

pause: disabled; enable: enabled

source_urls

No

Array of strings

Source URL for stream pull.

vod_loop_time

No

String

The default value is -1. -1: infinite loop until the specified end time arrives; N: N rounds of playback based on the file list. Playback terminates when either the N rounds are completed or the specified end time is reached, whichever comes first. If this parameter is not transferred or is left empty (""), the default value takes effect.

vod_refresh_type

No

String

The default value is immediate_new_source. The options are immediate_new_source, continue_from_file_start, and continue_from_break_point.

vod_start_video_index

No

Integer

Index of the file to be played. The value starts from 0, indicating the first file. The maximum value is len(source_urls) – 1. The default value is 0.

start_time

No

String

Task start time.

end_time

No

String

Task end time.

vod_start_video_time

No

Integer

Second from which the specified file is played. The default value is 0.

callback_events

No

Array of strings

List of events to be called back. If this parameter is left blank, all events are called back.

  • TaskStart: task start callback

  • TaskExit: task stop callback

  • VodSourceFileStart: file switchover callback (available only for PullVodPushLive tasks)

  • VodSourceFileFinish: file playback completion callback (available only for PullVodPushLive tasks)

  • ResetTaskConfig: task update callback (available only for PullVodPushLive tasks)

  • TaskAlarm: alarm event notification

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

task_id

String

Task ID.

request_id

String

Request ID.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

request_id

String

Request ID.

Example Requests

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" ]
}

Example Responses

Status code: 200

Live stream pull and push task modified successfully.

{
  "task_id" : "7864b3dc-e92f-42db-a754-08e627b6d8dd",
  "request_id" : "85968475-e92f-42db-a754-08e627b6d8dd"
}

Status code: 400

Failed to modify the live stream pull and push task.

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

Status Codes

Status Code

Description

200

Live stream pull and push task modified successfully.

400

Failed to modify the live stream pull and push task.

Error Codes

See Error Codes.

Parent topic: Stream Pull Management