すべてのプロダクト
Search

このプロダクト

    ApsaraVideo Live:ListEventSub

    ドキュメントセンター

    ApsaraVideo Live:ListEventSub

    最終更新日:Dec 13, 2025

    サブスクライブしたチャンネルで生成されたイベントを照会します。

    操作説明

    この操作は、アカウントごとに毎秒 50 回まで呼び出すことができます。この制限を超えたリクエストは破棄され、サービスが中断される可能性があります。この操作を呼び出す際は、この制限に注意することを推奨します。

    今すぐお試しください

    この 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: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
    CallbackUrl

    string

    コールバック URL。

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

    string

    サブスクリプションが作成された時間。時間は UTC+08:00 で表示されます。フォーマット：yyyy-MM-dd hh:mm:ss。

    2023-08-18 10:14:49
    ModifyTime

    string

    サブスクリプションが更新された時間。時間は UTC+08:00 で表示されます。フォーマット：yyyy-MM-dd hh:mm:ss。

    2023-08-18 10:14:49
    Users

    array

    イベントが返されるユーザー。このパラメーターまたは `Roles` のいずれかを使用することを推奨します。

    string

    このユーザーのイベントのみをコールバックします。`Roles` との併用は推奨されません。

    testUser
    Roles deprecated

    integer

    イベントが返されるユーザーのロール。有効な値：

    • 1：ストリーマー

    • 2：視聴者

    空の値、または 1 と 2 以外の値は、チャンネル内のすべてのユーザーのイベントが返されることを示します。

    説明

    このパラメーターは非推奨です。サブスクリプションを作成する際、このパラメーターはサポートされなくなりました。

    1

    例

    成功レスポンス

    JSONJSON

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

    エラーコード

    エラーメッセージ

    説明
    400 InputInvalid %s.
    500 ServerError %s.
    403 NoAuth %s.
    404 ResourceNotExist %s.

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

    変更履歴

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