Update Live Pull-to-Push Tasks Without Interruption - ApsaraVideo Live

You can call the UpdateLivePullToPush operation to update a pull-to-push task.

Operation description

You can call this operation to update a pull-to-push task.
The Region can be updated only before the task's scheduled start time.
While a task is running (including during retry attempts for exceptions), you can update only the CallbackUrl and RepeatTime parameters. The changes take effect immediately.
If a task is stopped, you can update all parameters except for Region.

QPS limit

You can call this operation up to 10 times per second per account. Exceeding this limit triggers throttling, which can impact your business. We recommend that you call this operation reasonably.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

live:UpdateLivePullToPush

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-beijing
TaskId	string	Yes	The task ID.	fd245384-4067-4f91-9d75-9666a6bc****
Region	string	Yes	The region where the task runs. Valid values: `ap-southeast-1`: Asia Pacific SE 1 (Singapore) `ap-southeast-5`: Asia Pacific SE 5 (Jakarta) `cn-beijing`: China (Beijing) `cn-shanghai`: China (Shanghai)	cn-shanghai
StartTime	string	No	The start time of the task. Note The time must be in the `yyyy-MM-ddTHH:mm:ssZ` format and in Coordinated Universal Time (UTC). You cannot update this parameter after the task starts.	2024-08-23T15:30:00Z
EndTime	string	No	The end time of the task. Note The time must be in the `yyyy-MM-ddTHH:mm:ssZ` format and in Coordinated Universal Time (UTC). `EndTime` must be later than `StartTime`. `EndTime` must be later than the current time. You cannot update this parameter after the task ends.	2024-08-27T14:30:00Z
SourceUrls	array	No	A list of source stream URLs. Note For `live` sources, specify only one live stream URL. For `vod` or `url` sources, you can specify up to 30 URLs. For `live` sources, you can use the RTMP, SRT, or HTTP-FLV protocols. For `vod` sources, specify the media asset IDs from ApsaraVideo for VOD. For `url` sources, you can use the MP4 or HTTP-FLV protocols. Updates to live source streams take effect immediately. For video file sources, the update is applied after the current video finishes playing, and the new playlist starts from the beginning. This parameter must be updated while the task is stopped. The change takes effect after the task restarts.	changedtesturl
	string	No	The URL of a source stream. Note For `live` sources, specify only one live stream URL. For `vod` or `url` sources, you can specify up to 30 URLs. For `live` sources, you can use the RTMP, SRT, or HTTP-FLV protocols. For `vod` sources, specify the media asset IDs from ApsaraVideo for VOD. For `url` sources, you can use the MP4 or HTTP-FLV protocols. Updates to live source streams take effect immediately. For video file sources, the update is applied after the current video finishes playing, and the new playlist starts from the beginning. This parameter must be updated while the task is stopped. The change takes effect after the task restarts.	rtmp://pulltest.****.aliyunlive.com/pulltest493/pulltest-w434
RepeatNumber	integer	No	The number of times the playlist repeats after it finishes. Valid values: `0` (default): Does not repeat. `-1`: Loops indefinitely. A positive integer: The number of times to repeat playback. Note This parameter applies only to `vod` or `url` source streams. Updates to this parameter take effect immediately.	0
Offset	integer	No	The playback offset for a video file, in seconds. The value must be greater than 0. Note Playback starts from the specified time offset relative to the first frame. This parameter applies only to `vod` or `url` source streams. This parameter applies only to the first video in the playlist. This parameter must be updated while the task is stopped. The change takes effect after the task restarts.	2
CallbackUrl	string	No	The webhook for task event notifications. If this parameter is omitted, no notifications are sent. Note The URL must be a valid webhook URL that can receive task-related events. The webhook URL cannot exceed 2,000 characters. If you do not specify this parameter, task event notifications are not sent. Updates to this parameter take effect when the next event is triggered.	https://callback*****.com
FileIndex	integer	No	The index of the video file in the playlist from which to start playback. Default value: 0. Note This parameter must be updated while the task is stopped. The change takes effect after the task restarts.	0

Response elements

Element	Type	Description	Example
	object	The response object.
RequestId	string	The ID of the request.	16A96B9A-F203-4EC5-8E43-CB92E68*****
RetCode	integer	The return code. Note A value of `0` indicates a successful call. For other values, see the "Errors" section.	0
Description	string	The error description.	OK

Examples

Success response

JSON format

{
  "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68*****",
  "RetCode": 0,
  "Description": "OK"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter	%s.	Parameter error
400	InvalidParam.CodeIllegalDuration	%s.	The value of start time should be less than the value of end time .
400	CodeInvalidAliUid	This aliuid does not have a live domain name.	This aluid does not have a live domain name.
400	CodeTaskNotExist	Task does not exist.	The task does not exist.
400	CodeTaskHasStarted	The task has already started.	The task has already started and cannot be updated.
500	InternalError	%s.	error on the live liveapi server.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.