DescribePlayList-阿里云帮助中心

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

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ice:DescribePlayList

none

*All Resource

*

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 elements

Element	Type	Description	Example
	object	Schema of Response
TotalNum	integer	The total playback count.	49
RequestId	string	The ID of the request.	B960580D-26FA-5547-8AFC-3CDC812DBF27
PageNum	integer	The page number.	1
PageSize	integer	The number of entries per page. Default value: 20. Valid values: 1 to 100.	10
PlayList	array<object>	The playback records.
	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

Success response

JSON format

{
  "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.
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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.