EditPlaylist - ApsaraVideo Live - Alibaba Cloud Documentation Center

Updates episodes in an episode list.

Operation description

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

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

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

Request parameters

Parameter	Type	Required	Description	Example
ProgramId	string	Yes	The ID of the episode list that you want to modify. It is included in the response when you call the AddPlaylistItems operation.	445409ec-7eaa-461d-8f29-4bec2eb9****
ProgramItems	string	Yes	The episodes that you want to modify or add. 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**"}]
ProgramConfig	string	No	The new configurations of the episodes that you want to modify or add. For more information, see the ProgramConfig section of this topic.	[{"RepeatNumber":"0","ProgramName":"my program"}]

InputProgramItem

Parameter	Example	Type	Description
ItemName	item1	String	The name of the episode.
ResourceType	vod	String	The type of the episode resource. Valid value:

ProgramConfig

Parameter	Example	Type	Description
RepeatNumber	0	Integer	The number of times the episode repeats after the first playback is complete. Valid values:

0: specifies to play the episode only once. This is the default value.

-1: specifies to play the episode in loop mode.

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	5c6a2a0d-f228-4a64-af62-20e91b96****
CasterId	string	The ID of the streaming panel.	0e94d1f4-1a65-445c-9dcf-de8b3b8d****
ProgramId	string	The ID of the episode list that was modified.	445409ec-7eaa-461d-8f29-4bec2eb9****
Items	object	The information about the episodes that you want to modify or add.
SuccessItems	array<object>	The episodes that were modified or added.
SuccessItem	object
ItemName	string	The name of the episode.	item1
ItemId	string	The ID of the episode.	c09f3d63-eacf-4fbf-bd48-a07a6ba7****
FailedItems	array<object>	The episodes that failed to be modified or added.
FailedItem	object
ItemName	string	The name of the episode.	item2
ItemId	string	The ID of the episode.	c09f3d63-eacf-4fbf-bd48-a07a6ba7****

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status code	Error code	Error message
400	InvalidProgramId.Malformed	%s
400	PlayListIsEmpty	%s
400	MissInputParams	%s
400	InvalidCasterId.Malformed	%s
400	IncorrectPlaylistStatus.Inuse	%s
400	InvalidParameter.Malformed	%s
404	PlayListNotFound	%s
404	InvalidCaster.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