RestartLivePullToPush - ApsaraVideo Live - Alibaba Cloud Documentation Center

Operation description

You can call this operation to restart a stream pulling and ingest task.
You can restart a running task, a task in an abnormal retry state, or a stopped task. A running task is stopped and then restarted. A stopped task is started immediately.
The restart is invalid if the task has not reached its configured start time.
When a task is restarted, it runs based on the latest configuration. This causes an interruption in stream ingest.
If a video-on-demand (VOD) task is restarted, playback starts from the beginning of the latest playlist. To resume playback, you can call the update operation to set the video index and playback progress.

QPS limits

The queries per second (QPS) limit for a single user is 10 calls per second. API calls that exceed this limit are throttled, which may affect your business. Plan your calls accordingly.

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:RestartLivePullToPush

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The ID of the region.	cn-shanghai
Region	string	Yes	The live center. Valid values: ap-southeast-1: Singapore ap-southeast-5: Indonesia cn-beijing: China (Beijing) cn-shanghai: China (Shanghai)	preregion
TaskId	string	Yes	The ID of the task.	6f869419-0692-4fd5-8cf0-66cab659****

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The ID of the request.	a05e6b15-15af-405b-a4a2-01522450****
TaskId	string	The ID of the new task.	fb0d4ac7-c7e3-4978-9743-0bf2f6e8****

Examples

Success response

JSON format

{
  "RequestId": "a05e6b15-15af-405b-a4a2-01522450****",
  "TaskId": "fb0d4ac7-c7e3-4978-9743-0bf2f6e8****"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter	%s.	Parameter error
400	LiveServiceNotFound	Your account does not open Live service yet	Your account has not yet activated ApsaraVideo Live.
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.
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.