AddShowIntoShowList - ApsaraVideo Live - Alibaba Cloud Documentation Center

Adds an episode to an episode list.

Operation description

Before you call this operation, you must create a production studio in playlist mode and add video resources to the production studio. Then, you can call this operation to add shows from the production studio to the playlist. To create a production studio using an API, see Create a production studio.

You can add a maximum of 1,000 shows to a playlist.

Important

When you use resources from ApsaraVideo VOD, prioritize resources from hosted buckets. Resources from your own buckets may expire. If you use resources from your own buckets, be aware of their validity period.
When you add media resources to a production studio, prioritize resources from ApsaraVideo LIVE and ApsaraVideo VOD. If you add a resource from a third-party URL, playback may fail. Ensure that the resource is of high quality and is valid.

QPS limits

The queries per second (QPS) limit for this operation is 10 calls per second per user. API calls that exceed this limit are throttled, which may affect your business. We recommend that you call this operation at a reasonable rate to prevent throttling.

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

create

*Caster

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

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The ID of the region.	cn-shanghai
showList	array<object>	No	The list of show resources to add. Each resource has its own parameters, such as showName and resourceUrl.
	object	No	The information about the show.
duration	integer	No	The playback duration of a single show, in seconds. Note You can set only one of the RepeatTimes and Duration parameters.	20
liveInputType	integer	No	The custom type tag.	1
repeatTimes	integer	No	The number of times a single show is played in a loop. The default value is 0. Note You can set only one of the RepeatTimes and Duration parameters. RepeatTimes specifies the number of repetitions. For example, a value of 0 means the show is played once (not repeated), and a value of 1 means the show is played twice (repeated once).	0
resourceId	string	No	The ID of the VOD file.	a2b8e671-2fe5-4642-a2ec-bf93880e****
resourceType	string	No	The type of the media asset. Valid values: live: live stream vod: VOD asset pic: image Note When using resources from ApsaraVideo VOD, prioritize resources from hosted buckets. Resources from your own buckets may expire. If you use resources from your own buckets, note their validity period. Live stream files support live stream assets and third-party URLs. VOD files support VOD assets, image assets, and third-party URLs.	vod
resourceUrl	string	No	The URL of the playback file.	http://**/atestObject**.m3u8
showName	string	No	The name of the show.	liveShow****
CasterId	string	Yes	The ID of the production studio. If you create a production studio by calling the CreateCaster operation, use the CasterId value that is returned in the response. If you create a production studio in the ApsaraVideo LIVE console, go to the ApsaraVideo LIVE console > Production Studio > Cloud Production Studio page to view the name of the production studio. Note The name of the production studio in the list on the Cloud Production Studio page is the ID of the production studio.	LIVEPRODUCER_POST-cn-0pp1czt****
ShowName	string	No	The name of the show.	liveShow****
ResourceType	string	No	The type of the media asset. Valid values: live: live stream vod: VOD asset pic: image Note When using resources from ApsaraVideo VOD, prioritize resources from hosted buckets. Resources from your own buckets may expire. If you use resources from your own buckets, note their validity period. Live stream files support live stream assets and third-party URLs. VOD files support VOD assets, image assets, and third-party URLs.	vod
ResourceUrl	string	No	The URL of the playback file.	http://**/atestObject**.m3u8
ResourceId	string	No	The ID of the VOD file.	a2b8e671-2fe5-4642-a2ec-bf93880e****
Duration	integer	No	The playback duration of a single show, in seconds. Note You can set only one of the RepeatTimes and Duration parameters.	20
RepeatTimes	integer	No	The number of times a single show is played in a loop. The default value is 0. Note You can set only one of the RepeatTimes and Duration parameters. RepeatTimes specifies the number of repetitions. For example, -1 means the show is played in an infinite loop. 0 means the show is played once (not repeated). 1 means the show is played twice (repeated once).	0
Spot	integer	No	The position in the playlist where you want to insert the show. Positions are indexed from 0. By default, the show is added to the end of the current playlist.	1
LiveInputType	integer	No	The custom type tag.	1
isBatchMode	boolean	No	Specifies whether to add shows to the playlist in batches. Valid values: true: adds shows in batches. false: adds a single show. Note If you do not specify this parameter or leave it empty, a single show is added.	false

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	987DA143-A39C-5B5D-AF5B-3B07944A0036
ShowId	string	The show ID.	a2b8e671-2fe5-4642-a2ec-bf93880e****
failedList	string	The list of resources that failed to be added and the reasons for the failures.	failedList[Show1, Show2...]
successfulShowIds	string	The list of IDs of the shows that were successfully added.	f1933f16-5467-4308-b3a9-e8d451a90999，547436b8-c839-4469-a2c0-704c1ce5ce00

Examples

Success response

JSON format

{
  "RequestId": "987DA143-A39C-5B5D-AF5B-3B07944A0036",
  "ShowId": "a2b8e671-2fe5-4642-a2ec-bf93880e****",
  "failedList": "failedList[Show1, Show2...]",
  "successfulShowIds": "f1933f16-5467-4308-b3a9-e8d451a90999，547436b8-c839-4469-a2c0-704c1ce5ce00"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidUserId.Malformed	%s, please check userId.	The userId passed in is invalid, please check.
400	InvalidParameter.Malformed	There are invalid parameters: %s.	There are invalid parameters: %s.
400	InvalidCasterId.Malformed	%s, please check and try again later.	The parameter CasterId is invalid, please check and try again.
400	InvalidVodUrl.Malformed	%s, please check and try again later.	Parameter VodUrl is invalid, please check and try again.
400	MissingParameter	%s.	Missing parameter
401	IllegalOperation	%s, please check and try again later.	Operation not allowed, please check and try again.
500	InternalError	%s, please try again later.	Internal error, please try again later.
404	InvalidCaster.NotFound	%s, please check and try again later.	The guide station does not exist, please check and try again.
404	InvalidShowList.NotFound	%s, please check and try again later.	ShowList does not exist, please check and try again.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.