ListPlaylistItems - ApsaraVideo Live

Usage note

The ProgramId parameter is required in the request.

QPS limit

A single user can perform a maximum of 10 queries per second (QPS). Throttling is triggered when the number of calls per second exceeds the QPS limit. The throttling may affect your business. Thus, we recommend that you observe the QPS limit on this operation. For more information about what a single user means and the QPS details, see QPS limit on an API operation in ApsaraVideo Live.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters


Parameter	Type	Required	Example	Description
Action	String	Yes	ListPlaylistItems	The operation that you want to perform. Set the value to ListPlaylistItems.
ProgramId	String	Yes	445409ec-7eaa-461d-8f29-4bec2eb9****	The ID of the episode list that you want to query. It is included in the response when you call the AddPlaylistItems operation.
ProgramItemIds	String	No	c10f3d63-eacf-4fbf-bd48-a07a6ba7**,c09f3d63-eacf-4fbf-bd48-a07a6ba7**	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 specified episode list is returned.

Response parameters


Parameter	Type	Example	Description
ProgramItems	Array of ProgramItem		The episodes that were queried.
Index	Integer	1	The sequence number of the episode in the query result.
ProgramId	String	445409ec-7eaa-461d-8f29-4bec2eb9****	The ID of the episode list that you want to query.
ProgramItemId	String	c10f3d63-eacf-4fbf-bd48-a07a6ba7****	The ID of the episode.
ProgramItemName	String	playlistItem1	The name of the episode.
ResourceType	String	vod	The type of the episode resource.
ResourceValue	String	asdfasdf8as9df8sa9df89****	The ID of the episode resource.
RequestId	String	5c6a2a0d-f228-4a64-af62-20e91b9****	The ID of the request.
Total	Integer	1	The total number of episodes that were queried.

Examples

Sample requests

http(s)://live.aliyuncs.com/?Action=ListPlaylistItems
&ProgramId=445409ec-7eaa-461d-8f29-4bec2eb9****
&<Common request parameters>

Sample success responses

XML format

<ListPlaylistItemsResponse>
      <RequestId>5c6a2a0d-f228-4a64-af62-20e91b9****</RequestId>
      <ProgramItems>
           <ProgramItemName>playlistItem1</ProgramItemName>
           <ResourceValue>asdfasdf8as9df8sa9df89****</ResourceValue>
           <ProgramItemId>c10f3d63-eacf-4fbf-bd48-a07a6ba7****</ProgramItemId>
            <Index>1</Index>
            <ResourceType>vod</ResourceType>
            <ProgramId>445409ec-7eaa-461d-8f29-4bec2eb9****</ProgramId>
      </ProgramItems>
      <Total>1</Total>
</ListPlaylistItemsResponse>

JSON format

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

Error codes

For a list of error codes, visit the API Error Center.