Manage Playlist Items via AddPlaylistItems API - ApsaraVideo Live - Alibaba Cloud - ApsaraVideo Live

Operation description

Create a production studio, add a production studio layout and production studio components, and then call this operation to add a playlist item. If no playlist has been created, the system automatically creates one. To create a production studio by using an API operation, see CreateCaster.

QPS limit

The single-user QPS limit for this operation is 10 calls per second. If the limit is exceeded, the API call is throttled, which may affect your business. Call this operation appropriately.

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

create

*Caster

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

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-shanghai
CasterId	string	Yes	The production studio ID. If you created the production studio by calling the CreateCaster operation, check the CasterId parameter value returned by the CreateCaster operation. If you created the production studio in the ApsaraVideo Live console, navigate to ApsaraVideo Live console > Production Studios > Cloud Production Studio to view the production studio name. Note The production studio name in the production studio list on the Cloud Production Studio page of the ApsaraVideo Live console is the production studio ID. The production studio must meet the following configurations: NormType: 3. Create a lightweight carousel production studio in advance. You can call the CreateCaster operation to create a production studio. CasterTemplate: lp_noTranscode. channelEnable: 0. programEffect: 1.	0e94d1f4-1a65-445c-9dcf-de8b3b8d****
ProgramItems	string	Yes	The list of playlist item inputs. The value 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**"}]
ProgramId	string	No	The playlist ID. If the production studio already has a playlist, you must specify the corresponding ProgramId. If no playlist has been created, you can leave this parameter empty, and the system performs automatic creation.	445409ec-7eaa-461d-8f29-4bec2eb9****
ProgramConfig	string	No	The playlist item configuration. If this is the first time you add a playlist item, specify this parameter for initialization. For more information, see ProgramConfig.	[{"RepeatNumber":"0","ProgramName":"my program"}]

InputProgramItem

Parameter	Example	Type	Description
ItemName	item1	String	The playlist item name.
ResourceType	vod	String	The resource type. Valid values: vod: ApsaraVideo VOD resource. url: third-party video resource.
ResourceValue	5f8809f2-3352-4d1f-a8f7-86f9429f****	String	When ResourceType is set to vod, ResourceValue is the media asset ID. When ResourceType is set to url, ResourceValue is the third-party video URL.

ProgramConfig

Parameter	Example	Type	Description
RepeatNumber	0	Integer	The number of times to repeat playback after the playlist finishes. Valid values: 0 (default): no repeat playback. -1: loop indefinitely. Other positive integers: the number of times to repeat playback after the playlist finishes.
ProgramName	myprogram	String	The playlist name.

Response elements

Element	Type	Description	Example
	object
Items	object	The list of added playlist items.
FailedItems	array<object>	The list of playlist items that failed to be added.
	object
ItemId	string	The ID of the playlist item.	c09f3d63-eacf-4fbf-bd48-a07a6ba7****
ItemName	string	The name of the playlist item.	item1
SuccessItems	array<object>	The list of playlist items that were successfully added.
	object
ItemId	string	The ID of the playlist item.	c09f3d63-eacf-4fbf-bd48-a07a6ba7****
ItemName	string	The name of the playlist item.	item2
ProgramId	string	The playlist ID. This value can be used as a request parameter for deleting playlist items, querying playlist items, editing playlists, deleting playlists, querying playlists, starting playlists, and stopping playlists.	445409ec-7eaa-461d-8f29-4bec2eb9****
RequestId	string	The request ID.	5c6a2a0d-f228-4a64-af62-20e91b96****

Examples

Success response

JSON format

{
  "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	Description
400	InvalidCasterId.Malformed	%s, please check and try again later.	The parameter CasterId is invalid, please check and try again.
400	PlayListIsEmpty	%s, please check and try again later.	Playlist is empty, please check and try again.
400	MissInputParams	%s, please check and try again later.	Parameter is missing, please check and try again.
400	InvalidProgramId.Malformed	%s, please check and try again later.	The parameter ProgramId is invalid, please check and try again.
400	InvalidParameter.Malformed	There are invalid parameters: %s.	There are invalid parameters: %s.
500	InternalError	%s, please try again later.	Internal error, please try again later.
403	UserQuotaExceed	Quota exceeded: %s.	Quota exceeded: %s.
404	InvalidCaster.NotFound	%s, please check and try again later.	The guide station does not exist, please check and try again.
404	InvalidDomainName.NotFound	%s, please check and try again later.	Domain name does not exist, please check and try again.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.