ListPlaylistItems - ApsaraVideo Live - Alibaba Cloud Documentation Center

Queries the information about episodes in an episode list.

Operation description

You can call the AddPlaylistItems operation to add episodes to an episode list and then call this operation to query the episodes in the episode list

QPS limit

You can call this operation up to 10 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation.

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:
- The required resource types are displayed in bold characters.
- 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
live:ListPlaylistItems	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
ProgramId	string	Yes	The ID of the episode list. If the episode list was created by calling the AddPlaylistItems operation, check the value of the response parameter ProgramId to obtain the ID.	445409ec-7eaa-461d-8f29-4bec2eb9****
ProgramItemIds	string	No	The IDs of the episodes that you want to query. Separate episode IDs with commas (,). If you set this parameter, only the information about the specified episodes is returned. If you do not set this parameter, the information about all episodes in the episode list is returned.	c10f3d63-eacf-4fbf-bd48-a07a6ba7**,c09f3d63-eacf-4fbf-bd48-a07a6ba7**

Response parameters

Parameter	Type	Description	Example
	object
Total	integer	The total number of episodes.	1
RequestId	string	The request ID.	5c6a2a0d-f228-4a64-af62-20e91b9****
ProgramItems	array<object>	The episodes.
ProgramItem	object
Index	integer	The sequence number of the episode in the query result.	1
ResourceType	string	The resource type.	vod
ProgramItemId	string	The ID of the episode.	c10f3d63-eacf-4fbf-bd48-a07a6ba7****
ProgramId	string	The ID of the episode list. You can use the ID as a request parameter in the API operation that is used to edit the episode list, delete the episode list, query the information about the episode list, start the episode list, or stop the episode list.	445409ec-7eaa-461d-8f29-4bec2eb9****
ProgramItemName	string	The name of the episode.	playlistItem1
ResourceValue	string	The resource ID.	asdfasdf8as9df8sa9df89****

Examples

Sample success responses

JSONformat

{
  "Total": 1,
  "RequestId": "5c6a2a0d-f228-4a64-af62-20e91b9****",
  "ProgramItems": [
    {
      "Index": 1,
      "ResourceType": "vod",
      "ProgramItemId": "c10f3d63-eacf-4fbf-bd48-a07a6ba7****",
      "ProgramId": "445409ec-7eaa-461d-8f29-4bec2eb9****",
      "ProgramItemName": "playlistItem1",
      "ResourceValue": "asdfasdf8as9df8sa9df89****"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message
400	InvalidProgramId.Malformed	%s
400	InvalidParameter.Malformed	%s
404	PlayListNotFound	%s
500	InternalError	%s

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