全部產品
Search
文件中心

ApsaraVideo Live:ListEventSub - 查詢訂閱房間訊息列表

更新時間:Dec 13, 2025

查詢訂閱房間訊息列表。

介面說明

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

調試

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

調試

授權資訊

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

  • 操作:是指具體的許可權點。

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

  • 資源類型:是指操作中支援授權的資源類型。具體說明如下:

    • 對於必選的資源類型,用前面加 * 表示。

    • 對於不支援資源級授權的操作,用全部資源表示。

  • 條件關鍵字:是指雲產品自身定義的條件關鍵字。

  • 關聯操作:是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權,操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

live:ListEventSub

list

*Rtc

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

請求參數

名稱

類型

必填

描述

樣本值

AppId

string

應用 ID。

9qb1****

返回參數

名稱

類型

描述

樣本值

object

返回參數。

RequestId

string

請求 ID。

AE050E24-BE9B-1E79-BB30-7EA0BBAE7F08

Subscribers

array<object>

訂閱事件列表。

object

訂閱事件詳情。

SubId

string

訂閱事件 ID。

09be0d2254cb5a89f4cbd86403ec****

ChannelId

string

訂閱的頻道 ID。

testmodify

Events

array

訂閱的事件,取值:

  • ChannelEvent:頻道事件,包括頻道開啟與關閉。

  • UserEvent:使用者事件,包括使用者入離會等。

string

訂閱的事件,取值:

  • ChannelEvent:頻道事件,包括頻道開啟與關閉。

  • UserEvent:使用者事件,包括使用者入離會等。

ChannelEvent

CallbackUrl

string

回調地址。

http://****.com/callback

CreateTime

string

建立訂閱時間。東八區時間,是 UTC+8 時區的時間。格式:yyyy-MM-dd hh:mm:ss。

2023-08-18 10:14:49

ModifyTime

string

修改訂閱時間。東八區時間,是 UTC+8 時區的時間。格式:yyyy-MM-dd hh:mm:ss。

2023-08-18 10:14:49

Users

array

只回調此使用者的事件,不建議與 Roles 同用。

string

只回調此使用者的事件,不建議與 Roles 同用。

testUser

Roles deprecated

integer

回調哪個角色的事件,取值:

  • 1:只回調主播事件。

  • 2:只回調觀眾事件。

無值或其他值表示回調所有使用者事件。

說明

建立訂閱不再支援此參數,此參數已廢棄。

1

樣本

正常返回樣本

JSON格式

{
  "RequestId": "AE050E24-BE9B-1E79-BB30-7EA0BBAE7F08",
  "Subscribers": [
    {
      "SubId": "09be0d2254cb5a89f4cbd86403ec****",
      "ChannelId": "testmodify",
      "Events": [
        "ChannelEvent"
      ],
      "CallbackUrl": "http://****.com/callback",
      "CreateTime": "2023-08-18 10:14:49",
      "ModifyTime": "2023-08-18 10:14:49",
      "Users": [
        "testUser"
      ],
      "Roles": 1
    }
  ]
}

錯誤碼

HTTP status code

錯誤碼

錯誤資訊

描述

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

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

變更歷史

更多資訊,參考變更詳情