すべてのプロダクト
Search

このプロダクト

    ApsaraVideo Live:DescribeLiveStreamPushMetricDetailData

    ドキュメントセンター

    ApsaraVideo Live:DescribeLiveStreamPushMetricDetailData

    最終更新日:Jun 16, 2026

    指定されたドメイン名のアプリケーションおよびストリーム粒度でストリーム取り込みデータを照会します。

    操作説明

    • 単一のドメイン名のみ照会できます。複数のドメイン名を指定するとエラーが返されます。

    • リクエストごとの最大照会時間範囲：24 時間。

    • 最小照会粒度：1 分。

    • 最大照会期間：31 日間。

    • これはモニタリングデータAPIです。データの収集および処理方法は、課金に使用される方法とは異なります。課金照合のための使用量の計算にこのAPIを使用しないでください。

    QPS 制限

    このオペレーションのユーザーあたりの1 秒あたりの最大照会数（QPS）は10です。1 秒あたりの呼び出し数が制限を超えると、スロットリングがトリガーされます。これはビジネスに影響を与える可能性があります。このオペレーションを適切に呼び出してください。

    今すぐお試しください

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

    get

    *Domain

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

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    RegionId

    string

    任意

    リージョンID。

    cn-shanghai
    DomainName

    string

    必須

    • 照会する高速化ドメイン名。単一のドメイン名のみ照会できます。複数のドメイン名を指定するとエラーが返されます。

    • AppNameまたはStreamNameを指定しない場合、指定した高速化ドメイン名配下のすべてのストリームに対するストリーム粒度のデータが集計されずに返されます。

    • DomainNameが指定され、AppNameとStreamNameの両方がallに設定されている場合、指定した高速化ドメイン名配下のすべてのストリームに対するストリーム粒度の集計データが返されます。

    example.com
    StartTime

    string

    必須

    照会する時間範囲の開始時刻。ISO 8601 標準のUTCタイムゾーンで時刻を指定します。

    形式：YYYY-MM-DDThh:mm:ssZ。

    2022-09-10T20:00:00Z
    EndTime

    string

    必須

    照会する時間範囲の終了時刻。ISO 8601 標準のUTCタイムゾーンで時刻を指定します。終了時刻は開始時刻より後である必要があり、差は1 日を超えることはできません。

    形式：YYYY-MM-DDThh:mm:ssZ。

    2022-09-10T21:00:00Z
    AppName

    string

    任意

    ライブストリームが属するアプリケーションの名前。対応するアプリケーションのストリーム粒度データを照会するには、アプリケーション名を指定します。

    liveApp****
    StreamName

    string

    任意

    ライブストリームの名前。StreamNameを指定すると、指定したAppName 配下の指定したStreamNameに対するストリーム粒度のデータが返されます。StreamNameを指定する場合は、AppNameも指定する必要があります。

    liveStream****
    NextPageToken

    string

    任意

    ページネーショントークン。各照会では最大 5,000 行のデータが返されます。照会するデータが5,000 行を超える場合、レスポンスには次の照会の開始インデックスが含まれます。

    前の照会で返された最後の行の次の行からデータの照会を続行するには、リクエストにこのトークンを渡します。

    UjsM9x3aVcJi9a0-ArwJUTTC67C***37C0=

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    レスポンスパラメーター。

    DomainName

    string

    高速化ドメイン名。

    example.com
    EndTime

    string

    返されたデータの時間範囲の終了時刻。時刻はISO 8601 標準のUTCタイムゾーンに従います。

    形式：YYYY-MM-DDThh:mm:ssZ。

    2022-09-10T21:00:00Z
    NextPageToken

    string

    ページング照会トークン。各照会では最大 5,000 行のデータが返されます。照会するデータが5,000 行を超える場合、レスポンスには次の照会の開始インデックスが含まれます。

    前の照会で返された最後の行の次の行からデータの照会を続行するには、リクエストにこのトークンを渡します。

    UjsM9x3aVcJi9a0-ArwJUTTC67C***37C0=
    PageSize

    integer

    返されたデータ行数。

    5000
    RequestId

    string

    リクエストID。

    5EBF2AC3-4B73-40A5-8B32-83F49D5F035E
    StartTime

    string

    照会する時間範囲の開始時刻。ISO 8601 標準のUTCタイムゾーンで時刻を指定します。

    形式：YYYY-MM-DDThh:mm:ssZ。

    2022-09-10T20:00:00Z
    StreamDetailData

    object

    StreamData

    array<object>

    返されたデータエントリ。

    object

    返されたデータエントリ。

    AppName

    string

    アプリケーション名。

    liveApp****
    ReqBps

    number

    平均帯域幅。単位：Bps。

    133.33
    ReqTraffic

    integer

    総トラフィック。単位：バイト。

    1000
    StreamName

    string

    ストリーム名。

    liveStream****
    TimeStamp

    string

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

    2022-09-10T20:00:00Z

    例

    成功レスポンス

    JSONJSON

    {
  "DomainName": "example.com",
  "EndTime": "2022-09-10T21:00:00Z",
  "NextPageToken": "UjsM9x3aVcJi9a0-ArwJUTTC67C***37C0=",
  "PageSize": 5000,
  "RequestId": "5EBF2AC3-4B73-40A5-8B32-83F49D5F035E",
  "StartTime": "2022-09-10T20:00:00Z",
  "StreamDetailData": {
    "StreamData": [
      {
        "AppName": "liveApp****",
        "ReqBps": 133.33,
        "ReqTraffic": 1000,
        "StreamName": "liveStream****",
        "TimeStamp": "2022-09-10T20:00:00Z"
      }
    ]
  }
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 InvalidStartTime.Malformed Specified StartTime is malformed.
    400 InvalidEndTime.Malformed Specified EndTime is malformed.
    400 InvalidTime.Malformed Specified StartTime or 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.

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

    変更履歴

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