調用DescribePlayUserTotal擷取播放資料總量統計-ApsaraVideo for VOD-阿里雲

調用本介面擷取指定時間範圍內的每日播放資料總量統計，統計指標包括總播放次數、總播放使用者數、總播放時間長度、播放時間長度分布。

介面說明

目前服務地址僅支援：華東 2（上海）。
僅支援統計使用了阿里雲播放器 SDK 的播放資料。
以北京時間（UTC+8）為基準，每天上午 9 點產生前一天的播放資料統計。
支援查詢 2018-01-01 之後的資料，資料查詢的起止時間跨度最大為 180 天。

調試

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

調試

授權資訊

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

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

vod:DescribePlayUserTotal

get

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
StartTime	string	是	指定查詢的起始時間。格式為：yyyy-MM-ddTHH:mm:ssZ（UTC 時間）。	2016-06-29T13:00:00Z
EndTime	string	是	指定查詢的結束時間。格式為：yyyy-MM-ddTHH:mm:ssZ（UTC 時間）。說明結束時間需大於起始時間，且與起始時間的最大跨度為 180 天。	2016-06-30T13:00:00Z

返回參數

名稱	類型	描述	樣本值
	object
RequestId	string	請求 ID。	1FAFB884-D5A7-47D1-****-8928AA9C8720
UserPlayStatisTotals	object
UserPlayStatisTotal	array<object>	使用者每天播放總量統計資料。
	array<object>
Date	string	播放日期，格式為：yyyy-MM-ddTHH:mm:ssZ（UTC 時間）。	2016-06-30T13:00:00Z
PlayDuration	string	播放總時間長度。單位：毫秒。	9340070
PlayRange	string	播放時間長度分布。	"<=1m:74.3%;>1<=5m:22.8%;>5<=10m:1.0%;>10<=15m:1.0%;>15<=30m:1.0%"
VV	object	播放次數總量統計。
Flash	string	Flash 播放器播放總次數。	2
iOS	string	iOS 播放器播放總次數。	0
HTML5	string	HTML5 播放器播放總次數。	2
Android	string	Android 播放器播放總次數。	161
UV	object	播放使用者數總量統計。
Flash	string	Flash 播放器播放總使用者數。	1
iOS	string	iOS 播放器播放總使用者數。	0
HTML5	string	HTML5 播放器播放總使用者數。	1
Android	string	Android 播放器播放總使用者數。	2

樣本

正常返回樣本

JSON格式

{
  "RequestId": "1FAFB884-D5A7-47D1-****-8928AA9C8720",
  "UserPlayStatisTotals": {
    "UserPlayStatisTotal": [
      {
        "Date": "2016-06-30T13:00:00Z",
        "PlayDuration": "9340070",
        "PlayRange": "\"<=1m:74.3%;>1<=5m:22.8%;>5<=10m:1.0%;>10<=15m:1.0%;>15<=30m:1.0%\"",
        "VV": {
          "Flash": "2",
          "iOS": "0",
          "HTML5": "2",
          "Android": "161"
        },
        "UV": {
          "Flash": "1",
          "iOS": "0",
          "HTML5": "1",
          "Android": "2"
        }
      }
    ]
  }
}

異常返回樣本

JSON格式

{
    "RequestId":"1FAFB884-D5A7-47D1-82B5-8928AA9C8720",
    "HostId":"vod.cn-shanghai.aliyuncs.com",
    "Code":"InvalidStartTime.Malformed",
    "Message":"Specified StartTime is malformed."
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	InvalidStartTime.Malformed	Specified StartTime is malformed.	開始時間格式錯誤。
400	InvalidEndTime.Malformed	Specified EndTime is malformed.	結束時間格式錯誤。
400	InvalidEndTime.BeyondCurrent	EndTime beyond current time.
400	InvalidParamter	%s
400	InvalidEndTime.Mismatch	StartTime or EndTime is mismatch.	開始時間與結束時間不匹配

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

變更歷史

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