DescribeChannelUsers - 查詢頻道內線上使用者列表 - ApsaraVideo Live

介面說明

本介面用於查詢頻道內線上使用者列表的詳細資料。例如：您可以查詢直播模式下的使用者總數。

QPS 限制

本介面的單使用者 QPS 限制為 100 次/秒。超過限制，API 呼叫會被限流，這可能會影響您的業務，請合理調用。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

live:DescribeChannelUsers

list

*Rtc

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

無

請求參數

名稱	類型	必填	描述	樣本值
AppId	string	是	應用 ID，僅支援傳單個 ID。	aec****
ChannelId	string	是	已加入的頻道 ID，僅支援傳單個 ID。	testId

返回參數

名稱	類型	描述	樣本值
	object	Schema of Response
RequestId	string	請求 ID。	AD86847D-1F36-18C8-A995-5EEA34******
Timestamp	integer	當前時刻的時間戳記（UTC 時間）。	1691027655
IsChannelExists	boolean	頻道是否存在，取值： true：存在。 false：不存在。說明頻道無人後，會有若干秒的緩衝，此時介面返回 true，但互動者與觀眾人數都為 0。	true
InteractiveUserNumber	integer	互動者使用者總數。	1
LiveUserNumber	integer	頻道內的觀眾總數。	1
InteractiveUserList	array	互動使用者列表。
	string	互動使用者列表。	aaa
LiveUserList	array	觀眾列表。
	string	觀眾列表，最多返回 1000 人。	bbb

樣本

正常返回樣本

JSON格式

{
  "RequestId": "AD86847D-1F36-18C8-A995-5EEA34******",
  "Timestamp": 1691027655,
  "IsChannelExists": true,
  "InteractiveUserNumber": 1,
  "LiveUserNumber": 1,
  "InteractiveUserList": [
    "aaa"
  ],
  "LiveUserList": [
    "bbb"
  ]
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊
400	400	InvalidInput
401	401	InvalidAuth
500	500	SystemError, Please Check App And Channel Exists, RETRY
404	404	AppOrChannelNotExists

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

變更歷史

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