DescribePlayList - 播放记录列表接口 - 智能媒体服务

通过播放器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.

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。