RemoveTerminals - 从频道中踢出指定终端用户_视频直播(LIVE)-阿里云帮助中心

从频道中踢出指定终端用户。

接口说明

使用说明

本接口用于将指定终端用户从频道踢出。

QPS 限制

本接口的单用户 QPS 限制为 100 次/秒。超过限制，API 调用会被限流，这可能会影响您的业务，请合理调用。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
live:RemoveTerminals	none	Rtc acs:live:*:{#accountId}:rtc/{#AppId}	无	无

请求参数

名称	类型	必填	描述	示例值
AppId	string	是	应用 ID，仅支持传单个 ID。	aec****
ChannelId	string	是	已加入的频道 ID，仅支持传单个 ID。	testId
TerminalIds	array	是	用户列表 ID。
	string	是	用户 ID 列表，N 的取值：1~30。格式如下所示： `TerminalIds.1=** TerminalIds.2=** ......`	1811****

返回参数

名称	类型	描述	示例值
	object	返回信息。
RequestId	string	请求 ID。	16A96B9A-F203-4EC5-8E43-CB92E68F4AF8
Terminals	array<object>	用户 ID 信息列表。
Terminal	object	用户 ID 信息列表。
Code	integer	状态码，成功返回 0，失败返回错误码描述。	0
Message	string	删除终端操作结果。取值： Success：成功。 Failed：失败。	Success
Id	string	用户 ID。	1811****

示例

正常返回示例

JSON格式

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

错误码

HTTP status code	错误码	错误信息	描述
400	InputInvalid	%s.	输入参数不合法
403	NoAuth	%s.	没有权限
404	ResourceNotExist	%s.	请求资源不存在，请检查后重新尝试
500	ServerError	%s.	未知错误，请稍后重试或提交工单咨询。

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2024-10-18	OpenAPI 错误码发生变更	查看变更详情
2023-08-31	OpenAPI 错误码发生变更	查看变更详情