ListPlaylist - ApsaraVideo Live - Alibaba Cloud Documentation Center

Operation description

Call the AddPlaylistItems operation to add items to a playlist before you query it.

QPS limits

This operation is limited to 10 queries per second (QPS) per user. API calls that exceed this limit are throttled. Throttling may affect your business. Plan your calls accordingly.

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

live:ListPlaylist

get

*Caster

acs:live:*:{#accountId}:caster/{#CasterId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-shanghai
ProgramId	string	No	The ID of the playlist. If you specify this parameter, only the information about the specified playlist is returned. If you leave this parameter empty, the information about all playlists that belong to your account is returned. Use the ProgramId value returned by the AddPlaylistItems operation.	c09f3d63-eacf-4fbf-bd48-a07a6ba7****
Page	integer	No	The page number.	1
PageSize	integer	No	The number of entries to return on each page.	20

Response parameters

Parameter	Type	Description	Example
	object
ProgramList	array<object>	The list of playlists.
	object
CasterId	string	The ID of the production studio to which the playlist belongs. Use this ID as a request parameter to add, delete, modify, or query the layout of a virtual studio.	casdfasdfasfdasdflkasjdflaj****
DomainName	string	The streaming domain.	example.com
ProgramId	string	The ID of the playlist.	c09f3d63-eacf-4fbf-bd48-a07a6ba7****
ProgramName	string	The name of the playlist.	playlist1
RepeatNumber	integer	The number of times the playlist repeats after the first playback. Valid values: 0 (default): The playlist does not repeat. -1: The playlist plays in a loop. Other positive integers: The number of times the playlist repeats.	1
Status	integer	The status of the playlist. Valid values: 0: stopped. 1: running.	1
RequestId	string	The request ID.	5c6a2a0d-f228-4a64-af62-20e91b96****
Total	integer	The total number of playlists.	1

Examples

Success response

JSON format

{
  "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
500	InternalError	%s
404	PlayListNotFound	%s

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.