すべてのプロダクト
Search

このプロダクト

    ApsaraVideo Live:DescribeLiveMessageGroup

    ドキュメントセンター

    ApsaraVideo Live:DescribeLiveMessageGroup

    最終更新日:Jul 15, 2026

    ライブインタラクティブなグループの詳細を照会します。

    操作説明

    この操作を呼び出す前に、 CreateLiveMessageGroup を呼び出してインタラクティブなメッセージグループを作成しておく必要があります。

    QPS 制限

    この操作の単一ユーザー QPS 制限は、1 秒あたり 50 回の呼び出しです。制限を超えると、API の呼び出しがスロットリングされ、ビジネスに影響が出る可能性があります。この操作は適切に呼び出してください。

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

    • アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

    • API：アクションを具体的に実行するための API。

    • アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。

    • リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

      • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

      • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

    • 条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

    • 依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    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

    セッションの総数。このパラメーターは、グループが存在する場合にのみ返されます。

    50
    OnlineUserCounts

    integer

    グループ内のオンラインユーザー数。このパラメーターは、グループが存在する場合にのみ返されます。

    2
    MsgAmount

    object

    カテゴリ別のメッセージ数統計。このパラメーターは、グループが存在する場合にのみ返されます。

    integer

    メッセージ数。

    {1 : 20, 2 : 30}
    Deletatime

    integer

    削除時間。このパラメーターは、グループが削除された場合にのみ返されます。この値は秒単位の UNIX タイムスタンプです。

    1698299827
    Deletor

    string

    グループを削除したユーザー。このパラメーターは、グループが削除された場合にのみ返されます。

    uid1
    SuperLargeGroup

    boolean

    グループが super large グループであるかどうかを示します。有効な値:

    • True: super large グループです。

    • False: super large グループではありません。

    False

    例

    成功レスポンス

    JSONJSON

    {
  "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 ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 InputInvalid %s. 入力パラメーターが無効です。
    500 ServerError %s. 不明なエラーが発生しました。後でもう一度お試しいただくか、チケットを送信してください。
    403 NoAuth %s. 必須の権限がありません。
    404 ResourceNotExist %s. リクエストされたリソースが存在しません。リクエストを確認して再試行してください。

    完全なリストについては、「エラーコード」をご参照ください。

    変更履歴

    完全なリストについては、「変更履歴」をご参照ください。