DescribePlayList - 播放記錄列表介面 - Intelligent Media Services

通過播放器TraceId來擷取播放記錄列表，該介面有分頁。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

ice:DescribePlayList

none

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
PageNo	integer	是	頁碼。預設值：1。	1
PageSize	integer	是	每頁大小。	10
TraceId	string	否	播放器的 TraceId。	0bc5e70516766285805381012d271e
BeginTs	string	是	開始時間，預設查詢當天的時間。	1676170500011
EndTs	string	是	結束時間，不能超過 24 小時。	1682474405173
OrderType	string	否	排序類型。取值： DESC：倒序 ASC：正序	DESC
OrderName	string	否	排序名稱。取值： FirstFrameDuration：首幀耗時 PlayDuration：播放時間長度 VideoDuration：視頻時間長度 StuckDuration：卡頓時間長度	FirstFrameDuration
PlayType	string	否	播放類型。取值： vod：點播	vod
Status	string	否	播放狀態。取值： complete：播放完成 playing：播放中 unusual：播放異常	complete

返回參數

名稱	類型	描述	樣本值
	object	Schema of Response
TotalNum	integer	總播放次數	49
RequestId	string	請求 ID。	B960580D-26FA-5547-8AFC-3CDC812DBF27
PageNum	integer	當前頁碼。	1
PageSize	integer	分頁大小。預設值 20。最大值 100。	10
PlayList	array<object>	播放記錄列表
	object	播放記錄
Status	string	播放狀態	complete
VideoId	string	視頻 ID	250314203f0171eebff17035d0b20102
StuckDuration	string	卡頓時間長度	20
PlayDuration	string	播放時間長度	1000
FirstFrameDuration	string	首幀耗時	200
TraceId	string	播放器 TraceId	0b736abf16724820210842673d9543
PlayType	string	播放類型	vod
SessionId	string	播放器會話 ID	91488be2-8381-40c9-8494-e8afe22c4a2d
VideoDuration	string	視頻時間長度	2000
PlayTs	string	啟播時間戳記	1675922209572

{
	"code":"200",
	"data":{
		"PlayList":[
			{
				"Status":"unusual",
				"PlayTs":1700533661526,
				"PlayDuration":0.0000,
				"VideoId":"11222223333",
				"VideoDuration":227285.0000,
				"PlayType":"vod",
				"TraceId":"1840527851",
				"SessionId":"c031504c-c43c-5628-a1b7-3cddddjhd34370",
				"FirstFrameDuration":220,
				"StuckDuration":0.0000
			}
		],
		"TotalNum":1,
		"RequestId":"54D95240-6BE7-1BCB-B8FB-27141AE6A5E6",
		"PageNum":1,
		"PageSize":1
	},
	"httpStatusCode":"200",
	"requestId":"54D95240-6BE7-1BCB-B8FB-27141AE6A5E6",
	"successResponse":true
}

樣本

正常返回樣本

JSON格式

{
  "TotalNum": 49,
  "RequestId": "B960580D-26FA-5547-8AFC-3CDC812DBF27",
  "PageNum": 1,
  "PageSize": 10,
  "PlayList": [
    {
      "Status": "complete",
      "VideoId": "250314203f0171eebff17035d0b20102",
      "StuckDuration": "20",
      "PlayDuration": "1000",
      "FirstFrameDuration": "200",
      "TraceId": "0b736abf16724820210842673d9543",
      "PlayType": "vod",
      "SessionId": "91488be2-8381-40c9-8494-e8afe22c4a2d",
      "VideoDuration": "2000",
      "PlayTs": "1675922209572"
    }
  ]
}

錯誤碼

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.

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

變更歷史

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