文档

DescribePlayList - 播放记录列表接口

更新时间:

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

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
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
PlayListobject []

播放记录列表

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 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
    删除错误码:500
    删除错误码:502
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)
文档反馈