RemoveTerminals - ApsaraVideo Live - Alibaba Cloud Documentation Center

Removes users from a channel.

Operation description

You can call this operation to remove one or more users from a channel.

QPS limit

You can call this operation up to 100 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.

Debug

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:
- The required resource types are displayed in bold characters.
- 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.

Operation	Access level	Resource type	Condition key	Associated operation
live:RemoveTerminals	none	Rtc `acs:live::{#accountId}:rtc/{#AppId}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
AppId	string	Yes	The ID of the application. You can specify only one application ID in each request.	aec****
ChannelId	string	Yes	The ID of the channel. You can specify only one channel ID in each request.	testId
TerminalIds	array	Yes	The IDs of the users that you want to remove.
	string	Yes	The IDs of the users that you want to remove. Valid values of N: 1 to 30. Format: `TerminalIds.1=** TerminalIds.2=** ......`	1811****

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	16A96B9A-F203-4EC5-8E43-CB92E68F4AF8
Terminals	array<object>	The information about the users.
Terminal	object
Code	integer	The returned status code. A value of 0 indicates that the request is successful. If the request fails, an error message is returned.	0
Message	string	The result of removing the specified users from the channel. Valid values: Success Failed	Success
Id	string	The ID of the user.	1811****

Examples

Sample success responses

JSONformat

{
  "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4AF8",
  "Terminals": [
    {
      "Code": 0,
      "Message": "Success",
      "Id": "1811****"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	InputInvalid	%s.	Illegal input parameters
403	NoAuth	%s.	No permission
404	ResourceNotExist	%s.	The requested resource does not exist, please check and try again
500	ServerError	%s.	Unknown error, please try again later or submit a ticket for consultation.

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

Change history

Change time	Summary of changes	Operation
2024-10-18	The Error code has changed	View Change Details
2023-08-31	The Error code has changed	View Change Details