調用DescribeChannelParticipants API查詢頻道內線上使用者列表-ApsaraVideo for Live-阿里雲

介面說明

本介面用於查詢頻道內線上使用者列表，不包含使用者詳細資料。

QPS 限制

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

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

live:DescribeChannelParticipants

none

*Domain

acs:live:*:{#accountId}:domain/{#DomainName}

無

請求參數

名稱	類型	必填	描述	樣本值
AppId	string	是	應用 ID，僅支援傳單個 ID。	aec****
ChannelId	string	是	加入的頻道，僅支援傳單個 ID。	testId
PageNum	integer	否	當前頁碼。預設值為 1。	1
PageSize	integer	否	每頁顯示使用者數量，預設每頁顯示 10 條使用者資料。	10
Order	string	否	排序方式，取值： asc：遞增。 desc（預設值）：遞減。	asc

返回參數

名稱	類型	描述	樣本值
	object	Schema of Response
RequestId	string	請求 ID。	6159ba01-6687-4fb2-a831-f0cd8d1******
Times	integer	返回結果時間，使用 UNIX 時間戳記表示，單位：秒。	1557909133
TotalNum	integer	返回結果數。	3
TotalPage	integer	返回分頁數。	1
UserList	array	使用者識別碼列表。
	string	使用者識別碼列表，多個用英文逗號（,）分隔。	27f9**,bb87,df82**

樣本

正常返回樣本

JSON格式

{
  "RequestId": "6159ba01-6687-4fb2-a831-f0cd8d1******",
  "Times": 1557909133,
  "TotalNum": 3,
  "TotalPage": 1,
  "UserList": [
    "27f9****,bb87****,df82****"
  ]
}

錯誤碼

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

變更歷史

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