すべてのプロダクト
Search

このプロダクト

    ApsaraVideo Live:DescribeLiveUserStreamMetricData

    ドキュメントセンター

    ApsaraVideo Live:DescribeLiveUserStreamMetricData

    最終更新日:Jun 22, 2026

    指定されたストリーミングドメインのストリームレベルのバッチデータをクエリします。複数のプロトコルがサポートされています。

    操作説明

    説明

    HLS プロトコルの新規接続数のクエリはサポートされていません。HLS の同時接続数はデフォルト形式のリクエストに基づいてカウントされます。特殊な形式のリクエストはチケットを送信して設定する必要があります。デフォルト形式は以下のとおりです:

    • m3u8 リクエスト例: http(s)://example.aliyundoc.com/Appname/ StreamName.m3u8

    • ts リクエスト例: http(s)://example.aliyundoc.com/Appname/ StreamName/153xxxxxxxx_137xxxxx.ts

    設定

    • 単一クエリ制限: 1 回のクエリで最大 5000 行のデータを返すことができます。

    • ドメイン名クエリ制限: 単一のドメイン名のみサポートされます。複数のドメイン名を指定するとエラーが返されます。

    • 時間範囲制限: 最大クエリ時間範囲は 24 時間です。

    • 時間粒度制限: 最小クエリ粒度は 1 分です。

    • クエリ範囲制限: 最大クエリ範囲は 31 日です。

    • 呼び出し頻度制限: ユーザーあたりの最大呼び出し頻度は 1 秒あたり 10 回です。

    • 特殊パラメータの組み合わせ: DomainName が空でなく、AppName と StreamName の両方が all に設定されている場合、ストリーミングドメインの集計データが返されます。

    今すぐお試しください

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

    none

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    DomainName

    string

    任意

    クエリするストリーミングドメイン。

    説明

    単一のドメイン名のみサポートされています。複数のドメイン名を指定するとエラーが返されます。ドメイン名が空の場合、ユーザー配下のすべてのストリーミングドメインの集計データがクエリされます。AppName と StreamName が指定されていない場合、ドメイン配下のすべてのストリームのストリームレベルデータが返されます。

    test.com
    StartTime

    string

    必須

    クエリする時間範囲の開始時刻。ISO 8601 標準の YYYY-MM-DDThh:mm:ssZ 形式で指定します。時刻は UTC で指定する必要があります。

    2015-12-10T20:00:00Z
    EndTime

    string

    必須

    クエリする時間範囲の終了時刻。終了時刻は開始時刻より後でなければならず、差は 1 日を超えることはできません。ISO 8601 標準の YYYY-MM-DDThh:mm:ssZ 形式で指定します。時刻は UTC で指定する必要があります。

    2015-12-10T21:00:00Z
    AppName

    string

    任意

    アプリケーション名。対応するアプリケーションのストリームレベルデータをクエリするにはアプリケーション名を指定します。StreamName を指定する場合は、AppName も指定する必要があります。

    app
    StreamName

    string

    任意

    ストリーム名。StreamName が指定された場合、指定された AppName 配下の指定された StreamName のストリームレベルデータが返されます。StreamName を指定する場合は、AppName も指定する必要があります。

    test.flv
    Protocol

    string

    任意

    ストリームプロトコル名。対応するプロトコルのデータをクエリするにはプロトコル名を指定します。サポートされるプロトコル: flv、hls、rtmp、rts、p2p。複数のプロトコルのデータをクエリする場合はカンマ（,）で区切ります。複数プロトコルのデータは集約されず、ストリームレベルで出力されます。

    説明

    rts オプションは ARTC プロトコルを使用するリアルタイムストリーミング（RTS）ストリームをクエリします。

    • rts を使用する場合、xxx_AliRTS-opus トランスコーディングストリームを追加でカウントする必要がある場合があります。これは、Web で RTS ストリームを再生する際に、ストリーム名に _AliRTS-opus サフィックスが付加されたトランスコーディングストリームが自動的に生成され、トランスコーディングストリームデータが生成されるためです。詳細については、RTS サブ秒遅延自動トランスコーディングをご参照ください。

    flv
    PageNumber

    integer

    必須

    ページ番号。

    1
    PageSize

    integer

    必須

    1 ページあたりのエントリ数。最大値: 5000。

    10

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    レスポンスのスキーマ

    DomainName

    string

    ストリーミングドメイン情報。

    test.com
    EndTime

    string

    YYYY-MM-DDThh:mm:ssZ

    2015-12-10T21:00:00Z
    PageSize

    integer

    1 ページあたりのエントリ数。

    10
    RequestId

    string

    リクエスト ID。

    16A96B9A-F203-4EC5-8E43-CB92E68F****
    StartTime

    string

    クエリする時間範囲の開始時刻。時刻は ISO 8601 標準の YYYY-MM-DDThh:mm:ssZ 形式（UTC）です。

    2015-12-10T20:00:00Z
    StreamDetailData

    array<object>

    各時間間隔のトラフィックデータ。

    object

    返されたデータグループ。

    AppName

    string

    アプリケーション名。指定の有無にかかわらずこの値が返されます。

    app
    Bps

    number

    ストリームの 1 分あたりの合計帯域幅（bps 単位）。

    423304182.66
    Count

    integer

    ストリームの 1 分あたりの同時接続数の合計。

    説明

    同時接続数とは、単位時間内に同一ストリームへのクライアントプロセス接続の数を指します。

    423304182
    FlvBps

    number

    FLV プロトコルの帯域幅（bps 単位）。指定されたプロトコルが一致しない場合、このフィールドは返されません。

    454
    FlvCount

    integer

    FLV プロトコルの同時接続数。指定されたプロトコルが一致しない場合、このフィールドは返されません。

    32
    FlvTraffic

    number

    FLV プロトコルのトラフィック（バイト単位）。指定されたプロトコルが一致しない場合、このフィールドは返されません。

    1254
    HlsBps

    number

    HLS プロトコルの帯域幅（bps 単位）。指定されたプロトコルが一致しない場合、このフィールドは返されません。

    4456
    HlsCount

    integer

    HLS プロトコルの同時接続数。指定されたプロトコルが一致しない場合、このフィールドは返されません。

    56
    HlsTraffic

    number

    HLS プロトコルのトラフィック（バイト単位）。指定されたプロトコルが一致しない場合、このフィールドは返されません。

    568
    NewConns

    integer

    ストリームの 1 分あたりの新規接続数。

    450
    P2pBps

    number

    P2P プロトコルの帯域幅（bps 単位）。指定されたプロトコルが一致しない場合、このフィールドは返されません。

    6845
    P2pCount

    integer

    P2P プロトコルの同時接続数。指定されたプロトコルが一致しない場合、このフィールドは返されません。

    78
    P2pTraffic

    number

    P2P プロトコルのトラフィック（バイト単位）。指定されたプロトコルが一致しない場合、このフィールドは返されません。

    4102
    RtmpBps

    number

    RTMP プロトコルの帯域幅（bps 単位）。指定されたプロトコルが一致しない場合、このフィールドは返されません。

    3323
    RtmpCount

    integer

    RTMP プロトコルの同時接続数。指定されたプロトコルが一致しない場合、このフィールドは返されません。

    63
    RtmpTraffic

    number

    RTMP プロトコルのトラフィック（バイト単位）。指定されたプロトコルが一致しない場合、このフィールドは返されません。

    5568
    RtsBps

    number

    RTS プロトコルの帯域幅（bps 単位）。指定されたプロトコルが一致しない場合、このフィールドは返されません。

    2361
    RtsCount

    integer

    RTS プロトコルの同時接続数。指定されたプロトコルが一致しない場合、このフィールドは返されません。

    89
    RtsTraffic

    number

    RTS プロトコルのトラフィック（バイト単位）。指定されたプロトコルが一致しない場合、このフィールドは返されません。

    2322
    StreamName

    string

    ストリーム名。指定の有無にかかわらずこの値が返されます。

    test.flv
    TimeStamp

    string

    タイムスライスの開始時刻。時刻は ISO 8601 標準の yyyy-MM-ddTHH:mm:ssZ 形式（UTC+0）です。

    2015-12-10T20:00:00Z
    Traffic

    number

    ストリームの 1 分あたりの合計トラフィック（バイト単位）。

    423304182
    TotalCount

    integer

    エントリの合計数。

    50
    PageNumber

    integer

    ページ番号。

    1

    例

    成功レスポンス

    JSONJSON

    {
  "DomainName": "test.com",
  "EndTime": "2015-12-10T21:00:00Z",
  "PageSize": 10,
  "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F****",
  "StartTime": "2015-12-10T20:00:00Z",
  "StreamDetailData": [
    {
      "AppName": "app",
      "Bps": 423304182.66,
      "Count": 423304182,
      "FlvBps": 454,
      "FlvCount": 32,
      "FlvTraffic": 1254,
      "HlsBps": 4456,
      "HlsCount": 56,
      "HlsTraffic": 568,
      "NewConns": 450,
      "P2pBps": 6845,
      "P2pCount": 78,
      "P2pTraffic": 4102,
      "RtmpBps": 3323,
      "RtmpCount": 63,
      "RtmpTraffic": 5568,
      "RtsBps": 2361,
      "RtsCount": 89,
      "RtsTraffic": 2322,
      "StreamName": "test.flv",
      "TimeStamp": "2015-12-10T20:00:00Z",
      "Traffic": 423304182
    }
  ],
  "TotalCount": 50,
  "PageNumber": 1
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 Meter.ParamError Param Error:%s,Please Check Again.
    500 Meter.ServerInternalError The Request Processing Has Failed Due To Some Unknown Error.
    500 Meter.DataSourceQueryError Data Source Error:%s,Please Try Again.
    403 Meter.AuthError Authentication Failed,Please Try Again.
    502 Meter.ReadyTsError Get ReadyTs Failed,Please Try Again.

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

    変更履歴

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