すべてのプロダクト
Search
ドキュメントセンター

ApsaraVideo Live:DescribeLiveStreamMetricDetailData

最終更新日:Jun 17, 2026

指定されたドメイン名のストリームレベルのバッチデータをクエリします。1回のクエリで最大 5,000行のデータが返されます。

操作説明

指定されたドメイン名のストリームレベルデータを本操作で初めてクエリする場合は、本操作を使用する前に チケットを起票して、バックエンド設定をリクエストしてください。 チケットには以下の情報を記載してください:

  • クエリ対象のドメイン名。

  • ドメイン名配下の同時ライブストリームの最大数。

  • ライブストリームあたりの同時視聴者の最大数。

  • クライアントリクエストに含まれるプロトコルタイプ。

重要 本操作は 2025 年 9 月 30 日以降はメンテナンスの対象外となります。速やかに新しいストリームレベル操作 DescribeLiveUserStreamMetricData に移行してください。新しいストリームレベル操作では、バックエンド設定は不要です。

事前準備

  • HLS のオンライン視聴者数の集計は、デフォルトではサポートしていません。

  • 一度にクエリできるのは、単一のドメイン名のみです。

  • 大規模なクエリの最大期間:24 時間。

  • 最小クエリ粒度:1 分。

  • 最大クエリ範囲:31 日。

レート制限

この操作の単一ユーザー QPS 制限は 1 秒あたり 10 回です。この制限を超えた場合、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:DescribeLiveStreamMetricDetailData

none

*Domain

acs:cdn:*:{#accountId}:domain/{#DomainName}

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

RegionId

string

任意

リージョン ID です。

列挙値:

  • cn-shenzhen :

    cn-shenzhen

cn-shenzhen

DomainName

string

任意

  • クエリする高速化ドメイン名。一度にクエリできるドメイン名は 1 つのみです。複数のドメイン名を指定すると、エラーが返されます。

  • AppNameStreamName が指定されていない場合、ドメイン名配下のすべてのストリームのストリームレベルのデータが返されます。

  • ドメイン名を指定しない場合、アカウント配下のすべての高速化ドメイン名の集計データが返されます。

  • DomainName が指定され、AppNameStreamName の両方が all に設定されている場合、指定された高速化ドメイン名の集計データが返されます。

  • DomainName を指定する場合、そのドメイン名がライブストリーミングドメインであること、および、この API を呼び出すユーザーがそのドメイン名に対する必要な権限を持っていることを確認してください。

example.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 も指定する必要があります。

liveApp****

StreamName

string

任意

ストリーム名。AppName と共にこのパラメーターを指定すると、ストリームレベルのデータが返されます。

説明

StreamName を指定する場合は、AppName も指定する必要があります。

liveStream****

Protocol

string

任意

ストリームプロトコル。有効な値: flvhlsrtmprtsp2p

複数のプロトコルをカンマ (,) で区切って、複数のプロトコルのデータをクエリできます。複数プロトコルのデータは集計されず、ストリームレベルで出力されます。

説明

rts を指定すると、 ARTC プロトコルを使用するリアルタイムストリーミング (RTS) ストリームがクエリされます。

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

flv

NextPageToken

string

任意

ページ分割トークン。1 回のクエリで最大 5,000 件のデータが返されます。クエリ対象のデータが 5,000 件を超える場合、レスポンスに次のページを取得するための NextPageToken が返されます。このトークンを次のリクエストに含めることで、後続のデータを取得できます。

UjsM9x3aVcJi9a0-ArwJUTTC67CIBKLw*****

レスポンスフィールド

フィールド

説明

object

照会されたデータです。

DomainName

string

照会されたアクセラレーションドメイン名です。

example.com

EndTime

string

終了時刻です。時刻は ISO 8601 形式 (YYYY-MM-DDThh:mm:ssZ) に従います。時刻は UTC で表示されます。

2015-12-10T21:00:00Z

NextPageToken

string

次のクエリの開始インデックスです。この値は、クエリデータが一度に取得しきれない場合に返されます。

UjsM9x3aVcJi9a0-ArwJUTTC67C***37C0=

PageSize

integer

返されたデータの行数です。

5000

RequestId

string

リクエスト ID です。

B955107D-E658-4E77-B913-E0AC3D31693E

StartTime

string

開始時刻です。時刻は ISO 8601 形式 (YYYY-MM-DDThh:mm:ssZ) に従います。時刻は UTC で表示されます。

2015-12-10T20:00:00Z

StreamDetailData

object

StreamData

array<object>

返されたデータセットです。

object

返されたデータセットです。

AppName

string

アプリケーション名です。

app

Bps

number

ストリームの分単位の平均帯域幅です。単位:bps。

423304182.66

Count

integer

ストリームの分単位のオンライン視聴者の総数です。

423304182

FlvBps

number

FLV ストリームの帯域幅です。単位:bps。

説明

指定されたプロトコルが使用されていない場合、このパラメーターは返されません。

454

FlvCount

integer

FLV ストリームのオンライン視聴者数です。

説明

指定されたプロトコルが使用されていない場合、このパラメーターは返されません。

32

FlvTraffic

integer

FLV ストリームのトラフィックです。単位:バイト。

説明

指定されたプロトコルが使用されていない場合、このパラメーターは返されません。

1254

HlsBps

number

HLS ストリームの帯域幅です。単位:bps。

説明

指定されたプロトコルが使用されていない場合、このパラメーターは返されません。

4456

HlsCount

integer

HLS ストリームのオンライン視聴者数です。

説明

このパラメーターはサポートされていません。

56

HlsTraffic

integer

HLS ストリームのトラフィックです。単位:バイト。

説明

指定されたプロトコルが使用されていない場合、このパラメーターは返されません。

568

NewConns

string

ストリームへの分単位の新規接続数です。

450

P2pBps

number

P2P ストリームの帯域幅です。単位:bps。

説明

指定されたプロトコルが使用されていない場合、このパラメーターは返されません。

6845

P2pCount

integer

P2P ストリームのオンライン視聴者数です。

説明

指定されたプロトコルが使用されていない場合、このパラメーターは返されません。

78

P2pTraffic

integer

P2P ストリームのトラフィックです。単位:バイト。

説明

指定されたプロトコルが使用されていない場合、このパラメーターは返されません。

4102

RtmpBps

number

RTMP ストリームの帯域幅です。単位:bps。

説明

指定されたプロトコルが使用されていない場合、このパラメーターは返されません。

3323

RtmpCount

integer

RTMP ストリームのオンライン視聴者数です。

説明

指定されたプロトコルが使用されていない場合、このパラメーターは返されません。

63

RtmpTraffic

integer

RTMP ストリームのトラフィックです。単位:バイト。

説明

指定されたプロトコルが使用されていない場合、このパラメーターは返されません。

5568

RtsBps

number

RTS ストリームの帯域幅です。単位:bps。

説明

指定されたプロトコルが使用されていない場合、このパラメーターは返されません。

2361

RtsCount

integer

RTS ストリームのオンライン視聴者数です。

説明

指定されたプロトコルが使用されていない場合、このパラメーターは返されません。

89

RtsTraffic

integer

RTS ストリームのトラフィックです。単位:バイト。

説明

指定されたプロトコルが使用されていない場合、このパラメーターは返されません。

2322

StreamName

string

ストリーム名です。

test.flv

TimeStamp

string

タイムスライスの開始時刻です。

2015-12-10T20:00:00Z

Traffic

integer

ストリームの分単位の総トラフィックです。単位:バイト。

423304182

成功レスポンス

JSONJSON

{
  "DomainName": "example.com",
  "EndTime": "2015-12-10T21:00:00Z",
  "NextPageToken": "UjsM9x3aVcJi9a0-ArwJUTTC67C***37C0=",
  "PageSize": 5000,
  "RequestId": "B955107D-E658-4E77-B913-E0AC3D31693E",
  "StartTime": "2015-12-10T20:00:00Z",
  "StreamDetailData": {
    "StreamData": [
      {
        "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
      }
    ]
  }
}

エラーコード

HTTP ステータスコード

エラーコード

エラーメッセージ

説明

400 InvalidStartTime.Malformed Specified StartTime is malformed.
400 InvalidEndTime.Malformed Specified EndTime is malformed.
400 InvalidEndTime.Mismatch Specified end time does not math the specified start time.
400 InvalidTimeSpan The time span exceeds the limit.
400 InvalidPageToken The token of page is invalid.
400 InvalidAppName.Mismatch The AppName param must be passed.
400 InvalidStreamProtocol.NotSupport The specified stream protocol is not support.
400 InvalidStreamName.LengthTooLong The specified stream name is too long.
400 InvalidAppName.LengthTooLong The specified app name is too long.
400 InvalidTime.ValueNotSupported Specified Time is malformed.

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

変更履歴

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