EditPlaylist - ApsaraVideo Live

Usage notes

You can call this operation to update all configurations of episodes in an episode list or replace the episodes.

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. For more information, see QPS limits.

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	EditPlaylist	The operation that you want to perform. Set the value to EditPlaylist.
ProgramId	String	Yes	445409ec-7eaa-461d-8f29-4bec2eb9****	The ID of the episode list. If you call the AddPlaylistItems operation to add episodes to an episode list, you can obtain the ID of the episode list from the ProgramId parameter in the response.
ProgramItems	String	Yes	[{"ItemName":"item1","ResourceType":"vod","ResourceValue":"5f8809f2-3352-4d1f-a8f7-86f9429f**"}, {"ItemName": "item2","ResourceType": "vod","ResourceValue": "e7411c0b-dd98-4c61-a545-f8bfba6c**"}]	The episodes that you want to add to the production studio. The value is a JSON string. For more information, see the InputProgramItem section of this topic.
ProgramConfig	String	No	[{"RepeatNumber":"0","ProgramName":"my program"}]	The configurations of the episode list. For more information, see the ProgramConfig section of this topic.

InputProgramItem

Field	Example	Type	Description
ItemName	item1	String	The name of the episode.
ResourceType	vod	String	The resource type. Set the value to vod. Only video-on-demand (VOD) resources are supported.
ResourceValue	5f8809f2-3352-4d1f-a8f7-86f9429f****	String	The resource ID.

ProgramConfig

Field	Example	Type	Description
RepeatNumber	0	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.
ProgramName	myprogram	String	The name of the episode list.

Field

Example

Type

Description

RepeatNumber

0

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.

ProgramName

myprogram

String

The name of the episode list.

Response parameters

Parameter	Type	Example	Description
CasterId	String	0e94d1f4-1a65-445c-9dcf-de8b3b8d****	The ID of the production studio. You can use the ID as a request parameter in the API operation that is used to configure callbacks or add a virtual studio layout.
Items	Object		The information about the episodes.
FailedItems	Array of FailedItem		The episodes that failed to be added.
ItemId	String	c09f3d63-eacf-4fbf-bd48-a07a6ba7****	The ID of the episode.
ItemName	String	item2	The name of the episode.
SuccessItems	Array of SuccessItem		The episodes that were added.
ItemId	String	c09f3d63-eacf-4fbf-bd48-a07a6ba7****	The ID of the episode.
ItemName	String	item1	The name of the episode.
ProgramId	String	445409ec-7eaa-461d-8f29-4bec2eb9****	The ID of the episode list. You can use the ID as a request parameter in the API operation that is used to delete the episode list, query the information about the episode list, start the episode list, or stop the episode list.
RequestId	String	5c6a2a0d-f228-4a64-af62-20e91b96****	The request ID.

Examples

Sample requests

http(s)://live.aliyuncs.com/?Action=EditPlaylist
&ProgramId=445409ec-7eaa-461d-8f29-4bec2eb9****
&ProgramItems=[{"ItemName":"item1","ResourceType":"vod","ResourceValue":"5f8809f2-3352-4d1f-a8f7-86f9429f****"}, {"ItemName": "item2","ResourceType": "vod","ResourceValue": "e7411c0b-dd98-4c61-a545-f8bfba6c****"}]
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<?xml version="1.0" encoding="UTF-8" ?>
<EditPlaylistResponse>
    <RequestId>5c6a2a0d-f228-4a64-af62-20e91b96****</RequestId>
    <Items>
        <FailedItems>
            <ItemName>item2</ItemName>
           <ItemId>c09f3d63-eacf-4fbf-bd48-a07a6ba7****</ItemId>
       </FailedItems>
        <SuccessItems>
            <ItemName>item1</ItemName>
            <ItemId>c09f3d63-eacf-4fbf-bd48-a07a6ba7****</ItemId>
        </SuccessItems>
    </Items>
    <ProgramId>445409ec-7eaa-461d-8f29-4bec2eb9****</ProgramId>
    <CasterId>0e94d1f4-1a65-445c-9dcf-de8b3b8d****</CasterId>
</EditPlaylistResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "EditPlaylistResponse" : {
    "RequestId" : "5c6a2a0d-f228-4a64-af62-20e91b96****",
    "Items" : {
      "FailedItems" : {
        "ItemName" : "item2",
        "ItemId" : "c09f3d63-eacf-4fbf-bd48-a07a6ba7****"
      },
      "SuccessItems" : {
        "ItemName" : "item1",
        "ItemId" : "c09f3d63-eacf-4fbf-bd48-a07a6ba7****"
      }
    },
    "ProgramId" : "445409ec-7eaa-461d-8f29-4bec2eb9****",
    "CasterId" : "0e94d1f4-1a65-445c-9dcf-de8b3b8d****"
  }
}

Error codes

For a list of error codes, see Service error codes.