AddPlaylistItems - ApsaraVideo Live - Alibaba Cloud Documentation Center

Adds episodes to an episode list.

Operation description

Create a production studio, add a layout and components to the production studio, and then call this operation to add episodes. If no episode list exists in the production studio, this operation creates an episode list for the production studio. For more information about how to create a production studio, see CreateCaster .

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

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

Request parameters

Parameter	Type	Required	Description	Example
CasterId	string	Yes	The ID of the production studio. If the production studio was created by calling the CreateCaster operation, check the value of the response parameter CasterId to obtain the ID. If the production studio was created by using the ApsaraVideo Live console, obtain the ID on the Production Studio Management page. To go to the page, log on to the ApsaraVideo Live console and click Production Studios in the left-side navigation pane. Note You can find the ID of the production studio in the Instance ID/Name column. The production studio must use the following configurations: NormType: 3**. You need to call the CreateCaster operation to create a production studio for lightweight carousel playback in advance. CasterTemplate: lp_noTranscode. channelEnable: 0. programEffect**: 1.	0e94d1f4-1a65-445c-9dcf-de8b3b8d****
ProgramItems	string	Yes	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.	[{"ItemName":"item1","ResourceType":"vod","ResourceValue":"5f8809f2-3352-4d1f-a8f7-86f9429f**"}, {"ItemName": "item2","ResourceType": "vod","ResourceValue": "e7411c0b-dd98-4c61-a545-f8bfba6c**"}]
ProgramId	string	No	The ID of the episode list. If you do not specify this parameter, an episode list is created by default.	445409ec-7eaa-461d-8f29-4bec2eb9****
ProgramConfig	string	No	The configurations of the episode list. If the episode list is added to the production studio for the first time, specify this parameter to pass in the initial configurations. For more information, see the ProgramConfig section of this topic.	[{"RepeatNumber":"0","ProgramName":"my program"}]

InputProgramItem

Field	Example	Type	Description
ItemName	item1	String	The name of the episode.
ResourceType	vod	String	The resource type. Valid values: vod: an ApsaraVideo VOD resource url: a video resource from a third party
ResourceValue	5f8809f2-3352-4d1f-a8f7-86f9429f****	String	If ResourceType is set to vod, the value of ResourceValue is the ID of the media asset.If ResourceType is set to url, the value of ResourceValue is the URL of the third-party video.

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.

Response parameters

Parameter	Type	Description	Example
	object
Items	object	The information about the episodes.
FailedItems	array<object>	The episodes that failed to be added.
FailedItem	object
ItemId	string	The ID of the episode.	c09f3d63-eacf-4fbf-bd48-a07a6ba7****
ItemName	string	The name of the episode.	item1
SuccessItems	array<object>	The episodes that were added.
SuccessItem	object
ItemId	string	The ID of the episode.	c09f3d63-eacf-4fbf-bd48-a07a6ba7****
ItemName	string	The name of the episode.	item2
ProgramId	string	The ID of the episode list. You can use the ID as a request parameter in the API operation that is used to remove episodes, query episodes, edit an episode list, delete an episode list, query the information about an episode list, start playing an episode list, or stop playing an episode list.	445409ec-7eaa-461d-8f29-4bec2eb9****
RequestId	string	The request ID.	5c6a2a0d-f228-4a64-af62-20e91b96****

Examples

Sample success responses

JSONformat

{
  "Items": {
    "FailedItems": [
      {
        "ItemId": "c09f3d63-eacf-4fbf-bd48-a07a6ba7****",
        "ItemName": "item1"
      }
    ],
    "SuccessItems": [
      {
        "ItemId": "c09f3d63-eacf-4fbf-bd48-a07a6ba7****",
        "ItemName": "item2"
      }
    ]
  },
  "ProgramId": "445409ec-7eaa-461d-8f29-4bec2eb9****",
  "RequestId": "5c6a2a0d-f228-4a64-af62-20e91b96****"
}

Error codes

HTTP status code	Error code	Error message
400	InvalidCasterId.Malformed	%s
400	PlayListIsEmpty	%s
400	MissInputParams	%s
400	InvalidProgramId.Malformed	%s
400	InvalidParameter.Malformed	%s
403	UserQuotaExceed	%s
404	InvalidCaster.NotFound	%s
404	InvalidDomainName.NotFound	%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