全部產品
Search

搜尋本產品

    ApsaraVideo VOD：DescribeVodMediaPlayData

    文件中心

    ApsaraVideo VOD：DescribeVodMediaPlayData

    更新時間：Jul 21, 2026

    透過媒體 ID（即影音 ID）取得影音在指定日期的播放資料，包括存取使用者數、人均播放次數、播放總次數、人均播放時長、累計播放時長等資料。

    介面說明

    • 目前本介面的服務地址僅支援：華東 2（上海）。

    • 僅支援統計使用了阿里雲播放器 SDK 的播放資料，且不支援純音訊的流量統計。

    • 僅支援查詢過去 30 天以內的資料。

    重要 - 呼叫本介面之前，需確保阿里雲播放器 SDK 滿足以下條件：
    • Android 播放器 SDK 或 iOS 播放器 SDK

      • 播放器 SDK 版本為 5.4.9.2 及以上。

      • 已取得播放器 SDK 的 License 授權並接入 License，詳情請參見 License 管理。

      • 已開啟播放器 SDK 的埋點日誌上報功能，正常情況下，阿里雲播放器 SDK 的埋點日誌上報功能為預設開啟的。更多資訊，請參見 Android 端建立播放器、iOS 端建立播放器。

    • Web 播放器 SDK

      • 播放器 SDK 版本為 2.16.0 及以上。

      • 已申請開通播放品質監控的 License 授權並接入 License，可填寫 Web 播放器 SDK 加值服務申請表單 申請開通，License 接入方法，請參見 Web 端介面說明 中的 license 屬性。

      • 已開啟播放器 SDK 的埋點日誌上報功能，正常情況下，阿里雲播放器 SDK 的埋點日誌上報功能為預設開啟的。

    調試

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

    調試

    授權資訊

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

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

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

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

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

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

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

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

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    vod:DescribeVodMediaPlayData

    none

    *All Resource

    *

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    PlayDate

    string

    否

    播放日期，單位：天。格式為：yyyyMMdd。

    說明

    • 僅支援按天查詢。

    • 僅支援查詢過去 30 天以內的資料。

    20240322
    TerminalType

    string

    否

    播放器 SDK 的終端類型。傳入此參數，可篩選查詢指定終端類型的所有影音的播放資料。取值：

    • Native：Android 播放器 SDK 或 iOS 播放器 SDK。

    • Web：Web 播放器 SDK。

    Native
    Os

    string

    否

    播放端的作業系統。傳入此參數，可篩選查詢指定作業系統的所有影音的播放資料。取值：

    • Android

    • iOS

    • Windows

    • macOS

    • Linux

    Android
    Region

    string

    否

    服務地域。傳入此參數，可篩選查詢指定服務地域下的所有影音的播放資料。取值：

    • cn-beijing：華北 2（北京）

    • cn-shanghai：華東 2（上海）

    • cn-shenzhen：華南 1（深圳）

    • ap-northeast-1：日本（東京）

    • ap-southeast-1：新加坡

    • ap-southeast-5：印度尼西亞（雅加達）

    • eu-central-1：德國（法蘭克福）

    cn-beijing
    MediaId

    string

    否

    媒體 ID，即音/影片 ID（VideoId）。傳入此參數，可篩選查詢指定媒體 ID 的影音播放資料，僅支援設定一個媒體 ID。可透過以下方式取得：

    • 透過主控台上傳的音/影片，可登入影片點播主控台，選擇媒體資源庫 > 音/影片檢視音/影片 ID。

    • 透過 CreateUploadVideo 介面上傳音/影片時，音/影片 ID 為返回參數 VideoId 的值。

    • 音/影片上傳後，可透過 SearchMedia 介面查詢音/影片 ID，為請求後返回參數 VideoId 的值。

    9ae2af636ca6c10412f44891fc****
    PageNo

    integer

    是

    查詢資料的當前頁碼。傳入此參數，可指定查詢資料從第幾頁開始返回。

    1
    PageSize

    integer

    是

    每頁顯示的資料筆數。傳入此參數，可設定返回資料每頁顯示的筆數。最大值為 100。

    20
    OrderType

    string

    否

    排序類型，與 OrderName 參數搭配使用。傳入此參數，可設定返回資料按指定指標的升序或降序進行排列。取值：

    • ASC：升序，返回的資料按從小到大向下排列。

    • DESC：降序，返回的資料按從大到小向下排列。

    ASC
    OrderName

    string

    否

    指標名稱，與 OrderType 參數搭配使用。傳入此參數，可設定返回資料按指定指標的升序或降序進行排列。取值：

    • PlaySuccessVv：播放總次數。

    • PlayPerVv：人均播放次數。

    • PlayDuration：累計播放時長。

    • PlayDurationPerUv：人均播放時長。

    PlaySuccessVv

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    返回結果。

    RequestId

    string

    請求 ID。

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

    integer

    返回資料的總筆數。

    1
    PageNo

    integer

    返回資料的頁碼。

    1
    PageSize

    integer

    每頁顯示的資料筆數。

    20
    QoeInfoList

    array<object>

    返回資料列表。

    object

    返回資料詳情。

    VideoTitle

    string

    影音的名稱。

    Alibaba Cloud VOD video title
    VideoDuration

    number

    影音的時長，單位：秒。

    246
    MediaId

    string

    媒體 ID，即音/影片 ID（VideoId）。

    9ae2af636ca6c10412f44891fc****
    DAU

    number

    影音的存取使用者數，單位：個。

    5
    PlaySuccessVv

    number

    影音的播放總次數，單位：次。

    20
    PlayDurationPerUv

    number

    影音的人均播放時長，單位：秒。

    120
    PlayDuration

    number

    影音的累計播放時長，單位：秒。

    2400
    PlayPerVv

    number

    影音的人均播放次數，單位：次。

    4

    樣本

    正常返回樣本

    JSON格式

    {
  "RequestId": "25818875-5F78-4AF6-D7393642CA58****",
  "TotalCount": 1,
  "PageNo": 1,
  "PageSize": 20,
  "QoeInfoList": [
    {
      "VideoTitle": "阿里云VOD视频标题",
      "VideoDuration": 246,
      "MediaId": "9ae2af636ca6c10412f44891fc****",
      "DAU": 5,
      "PlaySuccessVv": 20,
      "PlayDurationPerUv": 120,
      "PlayDuration": 2400,
      "PlayPerVv": 4
    }
  ]
}

    錯誤碼

    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.

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

    變更歷史

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