All Products
Search

This Product

    ApsaraVideo Live:SetShowListBackground

    Document Center

    ApsaraVideo Live:SetShowListBackground

    Last Updated:Sep 11, 2025

    Sets the background for a playlist.

    Operation description

    • First, create a production studio in playlist mode. Then, you can call this operation to add background materials. To create a production studio using an API, see CreateCaster.

    • You can use this operation to create, update, or delete the background of a playlist. To delete the background, leave the ResourceType, ResourceUrl, and MaterialId parameters empty.

    Important

    • If you use ApsaraVideo VOD resources, prioritize resources from hosted buckets because resources from your own buckets may expire. If you use resources from your own buckets, take note of their expiration dates.

    • For material resources, prioritize resources from ApsaraVideo Live and ApsaraVideo VOD. Resources from third-party URLs may fail to play. You must ensure the quality and validity of these resources.

    QPS limit

    The queries per second (QPS) limit for this operation is 10 calls per second for each user. If you exceed the limit, API calls are throttled. This can impact your business. You must call this operation within the 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:SetShowListBackground

    update

    *Caster

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

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    RegionId

    string

    No

    The region ID.

    cn-shanghai
    CasterId

    string

    Yes

    The ID of the production studio.

    • If you create a production studio by calling the CreateCaster operation, use the CasterId value returned in the response.

    • If you create a production studio in the ApsaraVideo Live console, find the production studio name by navigating to ApsaraVideo Live console > Production Studios > Cloud Production Studios.

    Note

    The production studio name in the list on the Cloud Production Studios page is the production studio ID.

    LIVEPRODUCER_POST-cn-0pp1czt****
    ResourceType

    string

    No

    The type of the material. Valid values:

    • LIVE: live stream material. This type supports materials from ApsaraVideo Live and third-party URLs.

    • VOD: video-on-demand material. This type supports materials from ApsaraVideo VOD and third-party URLs.

    • PIC: image material. This type supports materials from ApsaraVideo VOD and third-party URLs.

    Note

    You can specify one of the three values or leave this parameter empty.

    VOD
    MaterialId

    string

    No

    The ID of the VOD material.

    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

    The response body.

    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
    400 MissingParameter %s
    400 InvalidParameter.Malformed %s
    400 InvalidParameter.PageSize %s
    400 InvalidParameter.PageNum %s
    400 InvalidParameter.Status %s
    400 InvalidParameter.StartTime %s
    400 InvalidParameter.EndTime %s
    400 LiveServiceNotFound %s
    500 InternalError %s
    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.