Restarts a pulled-stream relay task.
Operation description
- You can call this operation to restart a pulled-stream relay task.
- You can restart a task that is running (even if the task is in an abnormal retry state) or a task that is stopped. For a task that is running, this operation stops and then restarts it. For a task that is stopped, this operation directly starts it.
- You cannot restart a task if the start time specified for the task has not been reached.
- If a task is restarted, the task runs based on the latest configuration of the task. This interrupts stream ingest.
- If a task for a list of ApsaraVideo VOD resources is restarted, the list plays from the beginning based on the latest configuration. You can call an operation to update the video index and playback progress to achieve successive playback.
QPS limit
You can call this operation up to 10 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| live:RestartLivePullToPush | update | *All Resources * |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| Region | string | Yes | The region of the live center. Valid values:
Enumeration Value:
| preregion |
| TaskId | string | Yes | The task ID. | 6f869419-0692-4fd5-8cf0-66cab659**** |
Response parameters
Examples
Sample success responses
JSONformat
{
"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. |
For a list of error codes, visit the Service error codes.