RemoveTerminals - Remove terminal users from an RTC channel - ApsaraVideo Live

Operation description

Removes one or more terminal users from an RTC channel.

QPS limit

This operation allows a maximum of 100 requests per second per account. Requests that exceed this limit are throttled, which may affect your service.

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

none

*Rtc

acs:live:*:{#accountId}:rtc/{#AppId}

None

Request parameters

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

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	16A96B9A-F203-4EC5-8E43-CB92E68F4AF8
Terminals	array<object>	The removal result for each terminal user.
	object
Code	integer	The status code. A value of 0 indicates success. If the request fails, an error message is returned.	0
Message	string	The removal result. Valid values: Success Failed	Success
Id	string	The terminal user ID.	1811****

Examples

Success response

JSON format

{
  "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.	Invalid input parameters. Verify your parameters and try again.
500	ServerError	%s.	An internal server error occurred. Try again later or submit a ticket.
403	NoAuth	%s.	No permission.
404	ResourceNotExist	%s.	The requested resource does not exist. Verify your parameters and try again.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.