全部產品
Search

搜尋本產品

    ApsaraVideo Live：DescribeLiveMessageGroup

    文件中心

    ApsaraVideo Live：DescribeLiveMessageGroup

    更新時間：Jul 15, 2026

    查詢直播互動群組詳細資訊。

    介面說明

    呼叫本介面前，您必須已經呼叫 CreateLiveMessageGroup 建立互動訊息群組。

    QPS 限制

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

    調試

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

    調試

    授權資訊

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

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

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

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

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

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

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

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

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    live:DescribeLiveMessageGroup

    get

    *Rtc

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

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    AppId

    string

    是

    應用程式 ID。

    demo
    GroupId

    string

    是

    群組 ID。

    grouptest
    DataCenter

    string

    否

    資料中心，需要與 CreateLiveMessageApp 中的資料中心一致，當前支援上海（取值為 cn-shanghai）、新加坡（取值為 ap-southeast-1）。

    cn-shanghai

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    返回參數。

    RequestId

    string

    請求 ID。

    1815A27D-BAE2-10E6-89FD-D477951C****
    GroupId

    string

    群組 ID。

    grouptest
    CreatorId

    string

    建立者 ID。

    uid1
    AdminList

    array

    管理員清單。

    string

    管理員。

    ["uid1","uid2"]
    Createtime

    integer

    建立時間，用 UNIX 時間戳記表示，單位：秒。

    1698305471
    GroupName

    string

    群組名稱。

    mytestgroup
    GroupInfo

    string

    群組擴充資訊。

    testgroupinfo
    Delete

    boolean

    是否已刪除。

    false
    TotalTimes

    integer

    總 Session 次數。群組存在時才有此參數。

    50
    OnlineUserCounts

    integer

    當前線上的群組使用者數。群組存在時才有此參數。

    2
    MsgAmount

    object

    訊息數分類統計。群組存在時才有此參數。

    integer

    訊息數。

    {1 : 20, 2 : 30}
    Deletatime

    integer

    刪除時間。群組已被刪除時才有此參數。用 UNIX 時間戳記表示，單位：秒。

    1698299827
    Deletor

    string

    刪除者。群組已被刪除時才有此參數。

    uid1
    SuperLargeGroup

    boolean

    群組是否為超級大群。

    • True：是。

    • False：否。

    False

    樣本

    正常返回樣本

    JSON格式

    {
  "RequestId": "1815A27D-BAE2-10E6-89FD-D477951C****",
  "GroupId": "grouptest",
  "CreatorId": "uid1",
  "AdminList": [
    "[\"uid1\",\"uid2\"]"
  ],
  "Createtime": 1698305471,
  "GroupName": "mytestgroup",
  "GroupInfo": "testgroupinfo",
  "Delete": false,
  "TotalTimes": 50,
  "OnlineUserCounts": 2,
  "MsgAmount": {
    "key": 0
  },
  "Deletatime": 1698299827,
  "Deletor": "uid1",
  "SuperLargeGroup": true
}

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

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

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

    變更歷史

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