ListPlaylist - ApsaraVideo Live - Alibaba Cloud Documentation Center

Queries the information about one or more episode lists.

Operation description

You can call the AddPlaylistItems operation to add episode lists and then call this operation to query the episode lists.

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:ListPlaylist	get	Caster `acs:live::{#accountId}:caster/{#CasterId}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
ProgramId	string	No	The ID of the episode list. If you set this parameter, only the information about the specified episode lists is returned. If you do not set this parameter, the information about all episode lists that belong to the account is returned. If the episode list was created by calling the AddPlaylistItems operation, check the value of the response parameter ProgramId to obtain the ID.	c09f3d63-eacf-4fbf-bd48-a07a6ba7****
Page	integer	No	The page number.	1
PageSize	integer	No	The number of entries per page.	20

Response parameters

Parameter	Type	Description	Example
	object
ProgramList	array<object>	The episode lists.
ProgramInfo	object
CasterId	string	The ID of the production studio to which the episode list belongs. You can use the ID as a request parameter in the API operation that is used to add a layout to the virtual studio, delete a layout in the virtual studio, modify a layout of the virtual studio, or query layouts of the virtual studio.	casdfasdfasfdasdflkasjdflaj****
DomainName	string	The main streaming domain.	example.com
ProgramId	string	The ID of the episode list.	c09f3d63-eacf-4fbf-bd48-a07a6ba7****
ProgramName	string	The name of the episode list.	playlist1
RepeatNumber	integer	The number of playbacks after the first playback is complete. Valid values: 0 (default): specifies that the episode list is played only once. -1: specifies that the episode list is played in loop mode. Positive integer: specifies the number of times the episode list repeats after the first playback is complete.	1
Status	integer	The status of the episode list. Valid values: 0: stopped 1: running	1
RequestId	string	The request ID.	5c6a2a0d-f228-4a64-af62-20e91b96****
Total	integer	The total number of episode lists returned.	1

Examples

Sample success responses

JSONformat

{
  "ProgramList": [
    {
      "CasterId": "casdfasdfasfdasdflkasjdflaj****",
      "DomainName": "example.com",
      "ProgramId": "c09f3d63-eacf-4fbf-bd48-a07a6ba7****",
      "ProgramName": "playlist1",
      "RepeatNumber": 1,
      "Status": 1
    }
  ],
  "RequestId": "5c6a2a0d-f228-4a64-af62-20e91b96****",
  "Total": 1
}

Error codes

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

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

Change history

Change time	Summary of changes	Operation

No change history