StopLivePullToPush

Operation description

Call this operation to stop a stream pulling task.
You can forcibly stop a running task (including tasks in the abnormal retry state). This operation does not take effect on tasks that are not running.

QPS limit

The single-user QPS limit for this operation is 10 calls per second. If the limit is exceeded, API calls are throttled, which may affect your business. Call this operation appropriately.

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

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-shanghai
Region	string	Yes	The live center to query. Valid values: ap-southeast-1 (Singapore) ap-southeast-5 (Indonesia) cn-beijing (Beijing) cn-shanghai (Shanghai). Valid values: cn-shenzhen : Shenzhen. cn-qingdao : Qingdao. preregion : Pre-release. cn-beijing : Beijing. cn-shanghai : Shanghai. ap-southeast-1 : Singapore. eu-central-1 : Germany (Frankfurt). ap-northeast-1 : Japan (Tokyo). ap-southeast-5 : Indonesia. me-central-1 : Saudi Arabia (Riyadh).	preregion
TaskId	string	Yes	The task ID.	3bb44350-0c34-49c7-8c5e-cba5e6c0****

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	a05e6b15-15af-405b-a4a2-0152245d****
TaskId	string	The node ID returned when you create task.	fb0d4ac7-c7e3-4978-9743-0bf2f6e8****

Examples

Success response

JSON format

{
  "RequestId": "a05e6b15-15af-405b-a4a2-0152245d****",
  "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	CodeInvalidAliUid	This aliuid does not have a live domain name.	This aluid does not have a live domain name.
400	InvalidParam.CodeIllegalDuration	%s.	The value of start time should be less than the value of end time .
400	CodeTaskNotExist	Task does not exist.	The task does not exist.
400	CodeTaskHasStopped	The task has been stopped.	The task has been stopped.
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.