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

Modifying a Relay Task

Function

This API is used to modify a relay task. The modifications take effect only when source_type is set to PullVodPushLive for the task.

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

Definition

Task ID.

Constraints

N/A

Range

N/A

Default Value

N/A

status

No

String

Definition

Task status.

Constraints

N/A

Range

pause: disabled

  • enable: enabled

Default Value

N/A

source_urls

No

Array of strings

Definition

Source stream URL.

Constraints

Array length: 1 to 30

vod_loop_time

No

String

Definition

Number of video playback rounds.

Constraints

This parameter is valid only when source_type is set to PullVodPushLive.

Range

  • -1: loops continuously until the specified end time.

  • N: plays the file list for N rounds. Playback stops when the round count is exhausted or the end time is reached, whichever comes first.

  • If this parameter is not transferred or is left empty (""), the default value takes effect.

Default Value

-1

vod_refresh_type

No

String

Definition

Effective logic for updated video URLs (source_urls).

Constraints

This parameter is valid only when source_type is set to PullVodPushLive.

Range

  • immediate_new_source: immediately starts playback from a new file.

  • continue_from_file_start: resumes playback from the start of the last file that was streamed. This option is valid only for task updates.

  • continue_from_break_point: resumes playback from the exact breakpoint of the last file that was streamed. This option is valid only for task updates.

Default Value

immediate_new_source

vod_start_video_index

No

Integer

Definition

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

Constraints

This parameter is valid only when source_type is set to PullVodPushLive.

Default Value

0

Value range:

0~2147483647

start_time

No

String

Definition

Task start time.

Constraints

  • Time format: 2006-01-02T15:04:05Z

  • The start time must be earlier than the end time. The default value is the current time.

Range

N/A

Default Value

N/A

end_time

No

String

Definition

Task end time.

Constraints

  • Time format: 2006-01-02T15:04:05Z

  • The end time must be later than the start time. The maximum allowed end time is seven days after the start time.

Range

N/A

Default Value

N/A

vod_start_video_time

No

Integer

Definition

Second from which the specified file is played.

Constraints

This parameter is valid only when source_type is set to PullVodPushLive.

Default Value

0

Value range:

0~2147483647

callback_events

No

Array of strings

Definition

List of callback events. If this parameter is left blank, callbacks are sent for all events.

  • 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

Constraints

N/A

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

task_id

String

Definition

Task ID.

Range

N/A

request_id

String

Definition

Request ID.

Range

N/A

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

Modifying a relay task succeeded.

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

Status code: 400

Modifying a relay task failed.

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

Status Codes

Status Code

Description

200

Modifying a relay task succeeded.

400

Modifying a relay task failed.

Error Codes

See Error Codes.

Parent Topic: Stream Relay Management