ListPlaylistItems - ApsaraVideo Live - Alibaba Cloud Documentation Center

Operation description

Before you call this operation, you must call the AddPlaylistItems operation to add items to a playlist.

QPS limit

This operation has a queries per second (QPS) limit of 10 calls per user. If you exceed this limit, your API calls are throttled. Throttling can affect your business. We recommend that you call this operation at a reasonable rate.

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:ListPlaylistItems

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The ID of the region.	cn-shanghai
ProgramId	string	Yes	The ID of the playlist. You can obtain the ID from the ProgramId parameter in the response of the AddPlaylistItems operation.	445409ec-7eaa-461d-8f29-4bec2eb9****
ProgramItemIds	string	No	The IDs of the playlist items. Separate multiple IDs with commas (,). If you specify this parameter, only the information about the specified items is returned. If you leave this parameter empty, the information about all items in the playlist is returned.	c10f3d63-eacf-4fbf-bd48-a07a6ba7**,c09f3d63-eacf-4fbf-bd48-a07a6ba7**

Response parameters

Parameter	Type	Description	Example
	object
Total	integer	The number of playlist items.	1
RequestId	string	The ID of the request.	5c6a2a0d-f228-4a64-af62-20e91b9****
ProgramItems	array<object>	The list of playlist items.
	object
Index	integer	The orchestration index.	1
ResourceType	string	The type of the resource.	vod
ProgramItemId	string	The ID of the playlist item.	c10f3d63-eacf-4fbf-bd48-a07a6ba7****
ProgramId	string	The ID of the playlist. You can use this ID as a request parameter when you edit, delete, query, start, or stop the playlist.	445409ec-7eaa-461d-8f29-4bec2eb9****
ProgramItemName	string	The name of the playlist item.	playlistItem1
ResourceValue	string	The ID of the resource.	asdfasdf8as9df8sa9df89****

Examples

Success response

JSON format

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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.