DescribePlayList - - Alibaba Cloud Documentation Center

Retrieves playback records based on the player's TraceId. This API supports pagination.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
ice:DescribePlayList	none	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
PageNo	integer	Yes	The page number. Default value: 1.	1
PageSize	integer	Yes	The number of entries per page.	10
TraceId	string	No	The TraceId of the player.	0bc5e70516766285805381012d271e
BeginTs	string	Yes	The beginning of the time range to query. By default, the system queries data of the current day.	1676170500011
EndTs	string	Yes	The end of the time range to query. The time range cannot exceed 24 hours.	1682474405173
OrderType	string	No	The sort order. Valid values: DESC: descending order. ASC: ascending order.	DESC
OrderName	string	No	The criteria by which the sorting is performed. Valid values: FirstFrameDuration PlayDuration VideoDuration StuckDuration	FirstFrameDuration
PlayType	string	No	The playback type. Valid value: vod	vod
Status	string	No	The playback status. Valid values: complete playing unusual: A playback error occurs.	complete

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
TotalNum	long	The total playback count.	49
RequestId	string	The ID of the request.	B960580D-26FA-5547-8AFC-3CDC812DBF27
PageNum	long	The page number.	1
PageSize	long	The number of entries per page. Default value: 20. Valid values: 1 to 100.	10
PlayList	array<object>	The playback records.
Data	object	The playback record.
Status	string	The playback status.	complete
VideoId	string	The ID of the video.	250314203f0171eebff17035d0b20102
StuckDuration	string	The stuttering duration.	20
PlayDuration	string	The playback duration.	1000
FirstFrameDuration	string	Time to first frame.	200
TraceId	string	The TraceId of the player.	0b736abf16724820210842673d9543
PlayType	string	The playback type.	vod
SessionId	string	The ID of the player session.	91488be2-8381-40c9-8494-e8afe22c4a2d
VideoDuration	string	The duration of the video.	2000
PlayTs	string	The timestamp when the playback started.	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 }

Examples

Sample success responses

JSONformat

{
  "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
    }
  ]
}

Error codes

HTTP status code	Error code	Error message
400	Meter.ParamError	Param Error:%s,Please Check Again.
403	Meter.AuthError	Authentication Failed,Please Try Again.
500	Meter.ServerInternalError	The Request Processing Has Failed Due To Some Unknown Error.
500	Meter.DataSourceQueryError	Data Source Error:%s,Please Try Again.
502	Meter.ReadyTsError	Get ReadyTs Failed,Please Try Again.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2022-09-08	The Error code has changed. The response structure of the API has changed	View Change Details