使用RemoveTerminals API將指定使用者踢出頻道-ApsaraVideo for 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	否	使用者識別碼列表，N 的取值：1~30。格式如下所示： `TerminalIds.1=** TerminalIds.2=** ......`	1811****

返回參數

名稱	類型	描述	樣本值
	object	返回資訊。
RequestId	string	請求 ID。	16A96B9A-F203-4EC5-8E43-CB92E68F4AF8
Terminals	array<object>	使用者識別碼資訊列表。
	object	使用者識別碼資訊列表。
Code	integer	狀態代碼，成功返回 0，失敗返回錯誤碼描述。	0
Message	string	刪除終端操作結果。取值： Success：成功。 Failed：失敗。	Success
Id	string	使用者識別碼。	1811****

樣本

正常返回樣本

JSON格式

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

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	InputInvalid	%s.	輸入參數不合法
500	ServerError	%s.	未知錯誤，請稍後重試或提交工單諮詢。
403	NoAuth	%s.	沒有許可權
404	ResourceNotExist	%s.	請求資源不存在，請檢查後重新嘗試

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。