RemoveTerminals - ApsaraVideo Live

Removes one or more users from a channel.

Usage notes

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

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters


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

Response parameters


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

Examples

Sample requests

http(s)://live.aliyuncs.com/?Action=RemoveTerminals
&AppId=aec****
&ChannelId=testId
&TerminalIds=["1811****"]
&Common request parameters

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<RemoveTerminalsResponse>
    <RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4AF8</RequestId>
    <Terminals>
        <Code>0</Code>
        <Message>Success</Message>
        <Id>1811****</Id>
    </Terminals>
</RemoveTerminalsResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

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

Error codes

For a list of error codes, see Service error codes.