全部產品
Search

搜尋本產品

    ApsaraVideo VOD：DescribeVodPlayerCollectData

    文件中心

    ApsaraVideo VOD：DescribeVodPlayerCollectData

    更新時間：Jul 21, 2026

    查詢播放器播放彙總的資料。

    調試

    您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

    調試

    授權資訊

    下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    vod:DescribeVodPlayerCollectData

    none

    *All Resource

    *

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    AppId

    string

    是

    應用程式 ID。

    app-1000000
    StartTime

    string

    是

    查詢的開始時間。格式為：yyyy-mm-ddthh:mm:ssz（UTC 時間）。

    說明

    • 支援近一年播放資料歷史查詢。

    • 單次查詢時間範圍不超過 31 天。

    • 時間區間為左閉右開 [StartTime, EndTime)。

    2025-06-24T00:55:06Z
    EndTime

    string

    是

    查詢的結束時間。格式為：yyyy-mm-ddthh:mm:ssz（UTC 時間）。

    2025-06-05T15:59:59Z
    Interval

    string

    是

    設定查詢資料的時間粒度。取值：5m、1h 和 1d。根據您指定的 StartTime 和 EndTime 的時間跨度，支援設定的時間粒度如下：

    • 3 天以內支援：5m、1h 和 1d。

    • 4-7 天內支援：1h 和 1d。

    • 7 天以上支援：1d。

    1d
    TerminalType

    string

    是

    終端類型。取值：

    • web：Web 端。

    • mobile：Native 端。

    web
    Os

    string

    否

    播放端的作業系統。傳入此參數，可篩選查詢指定作業系統的播放資料。取值包含：Android、iOS、Harmony、Windows、MacOS 和 Linux。 不同端類型可選取值不同，對應關係如下：

    • native：Android、iOS、Harmony。

    • web：Android、iOS、Harmony、Windows、MacOs、Linux。

    多個 OS 以 #_# 進行分隔。

    Android、iOS、Windows
    Metrics

    string

    是

    指標類型，支援多選（最多支援 3 個指標）。

    說明

    • 百分比資料返回值為小數形式。

    播放品質 QoS 指標：

    • Vv：播放次數。

    • RealVv：實際播放量。

    • FirstFrame：首幀時間。

    • SecondPlayRate：秒開率。

    • SlowPlayRate：慢開率。

    • StuckCountRate：次數卡頓率。

    • SeekDuration：Seek 耗時。

    • StuckDuration100s：百秒卡頓耗時。

    • StuckCount100s：百秒卡頓次數。

    • PlayFailRate：播放失敗率。

    • SeedFailRate：未起播率。

    • AvgPlayBitrate：平均播放位元率。

    • AvgStartBitrate：平均起播位元率。

    • ErrorCount100s：百秒錯誤次數。

    播放體驗 QoE 指標：

    • Uv：播放使用者數。

    • AvgPerVv：人均播放次數。

    • AvgVideoDuration：平均影片時長。

    • AvgPerPlayDuration：人均播放時長。

    • AvgPerCompletionVv：人均完播次數。

    • CompletionVv：完播量。

    • CompletionRate：完播率。

    • AvgPlayDuration：平均播放時長。

    • JumpRate5s：5 秒跳出率。

    Vv,Uv,AvgPerVv
    Period

    string

    否

    用於確認環比分析的時間範圍，單位為天（d）。

    例如當傳值 1d（1 天）時，會取環比時間為 StartTime-1d ～ EndTime-1d 作為環比資料的時間範圍。

    1d

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    Schema of Response

    RequestId

    string

    Id of the request

    25818875-5F78-4AF6-D7393642CA58****
    DataList

    array<object>

    返回資料列表。

    object

    Metric

    string

    返回的資料指標。

    Vv
    Value

    number

    返回的資料指標數值。

    100.0
    ValueRefer

    number

    返回的資料指標環比數值。

    200.0
    ValueRatio

    number

    環比百分比。

    0.5

    樣本

    正常返回樣本

    JSON格式

    {
  "RequestId": "25818875-5F78-4AF6-D7393642CA58****",
  "DataList": [
    {
      "Metric": "Vv",
      "Value": 100,
      "ValueRefer": 200,
      "ValueRatio": 0.5
    }
  ]
}

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

    描述
    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.

    訪問錯誤中心查看更多錯誤碼。

    變更歷史

    更多資訊，參考變更詳情。