AI 助理
备案控制台
文档
输入文档关键字查找
首页

DescribePlayList - 播放记录列表接口

更新时间：
产品详情
我的收藏

通过播放器TraceId来获取播放记录列表，该接口有分页。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

  • 操作：是指具体的权限点。
  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
    • 对于必选的资源类型，用背景高亮的方式表示。
    • 对于不支持资源级授权的操作，用全部资源表示。
  • 条件关键字：是指云产品自身定义的条件关键字。
  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
操作访问级别资源类型条件关键字关联操作
ice:DescribePlayListnone
*全部资源
*
    无
无

请求参数

名称类型必填描述示例值
PageNointeger是

页码。默认值：1。

1
PageSizeinteger是

每页大小。

10
TraceIdstring否

播放器的 TraceId。

0bc5e70516766285805381012d271e
BeginTsstring是

开始时间，默认查询当天的时间。

1676170500011
EndTsstring是

结束时间，不能超过 24 小时。

1682474405173
OrderTypestring否

排序类型。取值：

  • DESC：倒序
  • ASC：正序
DESC
OrderNamestring否

排序名称。取值：

  • FirstFrameDuration：首帧耗时
  • PlayDuration：播放时长
  • VideoDuration：视频时长
  • StuckDuration：卡顿时长
FirstFrameDuration
PlayTypestring否

播放类型。取值：

  • vod：点播
vod
Statusstring否

播放状态。取值：

  • complete：播放完成
  • playing：播放中
  • unusual：播放异常
complete

返回参数

名称类型描述示例值
object

Schema of Response

TotalNumlong

总播放次数

49
RequestIdstring

请求 ID。

B960580D-26FA-5547-8AFC-3CDC812DBF27
PageNumlong

当前页码。

1
PageSizelong

分页大小。默认值 20。最大值 100。

10
PlayListarray<object>

播放记录列表

Dataobject

播放记录

Statusstring

播放状态

complete
VideoIdstring

视频 ID

250314203f0171eebff17035d0b20102
StuckDurationstring

卡顿时长

20
PlayDurationstring

播放时长

1000
FirstFrameDurationstring

首帧耗时

200
TraceIdstring

播放器 TraceId

0b736abf16724820210842673d9543
PlayTypestring

播放类型

vod
SessionIdstring

播放器会话 ID

91488be2-8381-40c9-8494-e8afe22c4a2d
VideoDurationstring

视频时长

2000
PlayTsstring

启播时间戳

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错误码错误信息
400Meter.ParamErrorParam Error:%s,Please Check Again.
403Meter.AuthErrorAuthentication Failed,Please Try Again.
500Meter.ServerInternalErrorThe Request Processing Has Failed Due To Some Unknown Error.
500Meter.DataSourceQueryErrorData Source Error:%s,Please Try Again.
502Meter.ReadyTsErrorGet ReadyTs Failed,Please Try Again.

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

变更历史

变更时间变更内容概要操作
2022-09-08OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情