SetShowListBackground

Operation description

Create a playlist mode production studio before calling this operation to add background materials. To create a production studio by using an API operation, see CreateCaster.
You can use this operation to create, update, or delete a playlist background. To delete the background, leave the ResourceType, ResourceUrl, and MaterialId parameters empty.

Important

When using ApsaraVideo VOD resources, use managed bucket resources first. Resources in your own bucket may expire. If you use resources in your own bucket, check the resource validity period.
Use ApsaraVideo Live and ApsaraVideo VOD resources as material input first. Resources from third-party URLs may fail to play. Verify the quality and validity of such resources.

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

update

*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 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 is the production studio ID.	LIVEPRODUCER_POST-cn-0pp1czt****
ResourceType	string	No	The material type. Valid values: LIVE: live streaming material. Supports live streaming materials and third-party URLs. VOD: video-on-demand material. Supports video-on-demand materials and third-party URLs. PIC: image material. Supports video-on-demand materials and third-party URLs. Note Specify one of the three values or leave this parameter empty. Valid values: VOD : video-on-demand material. PIC : image material. LIVE : live streaming material.	VOD
MaterialId	string	No	The video-on-demand material ID. Note Specify either this parameter or ResourceUrl.	a2b8e671-2fe5-4642-a2ec-bf93880e****
ResourceUrl	string	No	The URL of the external material.	http://**/atestObject**.m3u8

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	987DA143-A39C-5B5D-AF5B-3B07944A0036

Examples

Success response

JSON format

{
  "RequestId": "987DA143-A39C-5B5D-AF5B-3B07944A0036"
}

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	MissingParameter	%s.	Missing parameter
400	InvalidParameter.Malformed	There are invalid parameters: %s.	There are invalid parameters: %s.
400	InvalidParameter.Status	%s, please check and try again.	Status is invalid, please check and try again.
400	InvalidParameter.StartTime	%s, please check and try again later.	The parameter StartTime is invalid, please check and try again.
400	InvalidParameter.EndTime	%s, please check and try again later.	The parameter EndTime is invalid, please check and try again.
400	LiveServiceNotFound	%s, please check and try again later.	The live service is not enabled. Please check and try again.
500	InternalError	%s, please try again later.	Internal error, please try again later.
404	InvalidCaster.NotFound	The caster does not exist.	The caster does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.