EditPlaylist - ApsaraVideo Live - Alibaba Cloud Documentation Center

Operation description

This operation performs a full edit. You can use this operation to edit configuration information or replace multiple playlist items.

QPS limit

The queries per second (QPS) limit for a single user is 10 calls per second. If you exceed this limit, your API calls are throttled. This throttling can affect your business. Call this API within the specified limit.

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

get

*Caster

acs:live:*:{#accountId}:caster/{#CasterId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-shanghai
ProgramId	string	Yes	The playlist ID. If you add playlist items by calling the AddPlaylistItems operation, use the ProgramId value returned by the call.	445409ec-7eaa-461d-8f29-4bec2eb9****
ProgramItems	string	Yes	The list of playlist items. This is a JSON string. For more information, see InputProgramItem.	[{"ItemName":"item1","ResourceType":"vod","ResourceValue":"5f8809f2-3352-4d1f-a8f7-86f9429f**"}, {"ItemName": "item2","ResourceType": "vod","ResourceValue": "e7411c0b-dd98-4c61-a545-f8bfba6c**"}]
ProgramConfig	string	No	The playlist configuration. For more information, see ProgramConfig.	[{"RepeatNumber":"0","ProgramName":"my program"}]

InputProgramItem

Parameter	Example	Type	Description
ItemName	item1	String	The name of the playlist item.
ResourceType	vod	String	The resource type. The only valid value is vod, which indicates a Video-on-Demand (VOD) resource.
ResourceValue	5f8809f2-3352-4d1f-a8f7-86f9429f****	String	The ID of the resource.

ProgramConfig

Parameter	Example	Type	Description
RepeatNumber	0	Integer	The number of times to repeat the playlist after it finishes playing. Valid values: 0 (default): The playlist does not repeat. -1: The playlist loops indefinitely. Any other positive integer: The number of times to repeat the playlist.
ProgramName	myprogram	String	The name of the playlist.

Response parameters

Parameter	Type	Description	Example
	object
CasterId	string	The ID of the production studio. Use this ID as a request parameter to add a callback or a virtual studio layout.	0e94d1f4-1a65-445c-9dcf-de8b3b8d****
Items	object	The list of added playlist items.
FailedItems	array<object>	The list of playlist items that failed to be added.
	object	The list of playlist items that failed to be added.
ItemId	string	The ID of the playlist item.	c09f3d63-eacf-4fbf-bd48-a07a6ba7****
ItemName	string	The name of the playlist item.	item2
SuccessItems	array<object>	The list of playlist items that were successfully added.
	object	The list of successfully added items.
ItemId	string	The ID of the playlist item.	c09f3d63-eacf-4fbf-bd48-a07a6ba7****
ItemName	string	The name of the playlist item.	item1
ProgramId	string	The playlist ID. Use this ID as a request parameter to delete, query, start, or stop the playlist.	445409ec-7eaa-461d-8f29-4bec2eb9****
RequestId	string	The request ID.	5c6a2a0d-f228-4a64-af62-20e91b96****

Examples

Success response

JSON format

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

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
500	InternalError	%s
404	PlayListNotFound	%s
404	InvalidCaster.NotFound	%s

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.