All Products
Search
Document Center

:StopLivePullToPush

Last Updated:May 13, 2025

Stops a pulled-stream relay task.

Operation description

  • You can call this operation to stop a pulled-stream relay task.
  • You can stop a task that is running (even if the task is in an abnormal retry state). You cannot stop a task that is not running.

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

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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 Resources is 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.
OperationAccess levelResource typeCondition keyAssociated operation
live:StopLivePullToPushupdate
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionstringYes

The region of the live center. Valid values:

  • ap-southeast-1: Singapore
  • ap-southeast-5: Indonesia (Jakarta)
  • cn-beijing: China (Beijing)
  • cn-shanghai: China (Shanghai)
Enumeration Value:
  • ap-northeast-1
  • ap-southeast-1
  • ap-southeast-5
  • eu-central-1
  • me-central-1
  • cn-beijing
  • cn-shanghai
  • cn-shenzhen
  • cn-qingdao
  • preregion
preregion
TaskIdstringYes

The task ID.

3bb44350-0c34-49c7-8c5e-cba5e6c0****

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

The request ID.

a05e6b15-15af-405b-a4a2-0152245d****
TaskIdstring

The new task ID.

fb0d4ac7-c7e3-4978-9743-0bf2f6e8****

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
400InvalidParameter%s.Parameter error
400LiveServiceNotFoundYour account does not open Live service yetYour account has not yet activated ApsaraVideo Live.
400CodeInvalidAliUidThis aliuid does not have a live domain name.This aluid does not have a live domain name.
400InvalidParam.CodeIllegalDuration%s.The value of start time should be less than the value of end time .
400CodeTaskNotExistTask does not exist.The task does not exist.
400CodeTaskHasStoppedThe task has been stopped.The task has been stopped.
500InternalError%s.error on the live liveapi server.

For a list of error codes, visit the Service error codes.