All Products
Search

This Product

    ApsaraVideo Live:AddShowIntoShowList

    Document Center

    ApsaraVideo Live:AddShowIntoShowList

    Last Updated:Jul 15, 2026

    Adds a show to a playlist.

    Operation description

    Before calling this operation, create a playlist mode production studio (NormType=6) and add video resources to it. To create a production studio by using an API operation, refer to CreateCaster.

    Each playlist can contain up to 1000 shows.

    Important

    • When using video-on-demand (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 input for the production studio. 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 this limit is exceeded, the API calls are 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:AddShowIntoShowList

    create

    *Caster

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

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    RegionId

    string

    No

    The region ID.

    cn-shanghai
    showList

    array<object>

    No

    The list of show resources to add. Each resource has independent parameters such as showName and resourceUrl.

    object

    No

    The production studio list information.

    duration

    integer

    No

    The playback duration of a single show. Unit: seconds.

    Note

    • You can set only one of repeatTimes and duration.

    • This parameter is required when resourceType is set to live.

    20
    liveInputType

    integer

    No

    The custom type tag.

    1
    repeatTimes

    integer

    No

    The number of times a single show is repeated. Default value: 0.

    Note

    • You can set only one of repeatTimes and duration.

    • repeatTimes specifies the number of repetitions. For example, 0 means the show is repeated 0 times (played once), 1 means the show is repeated 1 time (played twice), and so on.

    0
    resourceId

    string

    No

    The VOD file ID.

    a2b8e671-2fe5-4642-a2ec-bf93880e****
    resourceType

    string

    No

    The resource type. Valid values:

    • live: live streaming resource.

    • vod: video-on-demand resource.

    • pic: image resource.

    Note

    • When using video-on-demand (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.

    • Live files support live streaming resources and third-party URLs.

    • VOD files support video-on-demand resources, image resources, and third-party URLs.

    • When using live streaming resources, you must also specify the duration parameter.

    vod
    resourceUrl

    string

    No

    The URL of the playback file.

    http://****/atestObject****.m3u8
    showName

    string

    No

    The show name.

    liveShow****
    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 of the ApsaraVideo Live console is the production studio ID.

    LIVEPRODUCER_POST-cn-0pp1czt****
    ShowName

    string

    No

    The show name.

    liveShow****
    ResourceType

    string

    No

    The resource type. Valid values:

    • live: live streaming resource.

    • vod: video-on-demand resource.

    • pic: image resource.

    Note

    • When using video-on-demand (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.

    • Live files support live streaming resources and third-party URLs.

    • VOD files support video-on-demand resources, image resources, and third-party URLs.

    • When using live streaming resources, you must also specify the Duration parameter.

    vod
    ResourceUrl

    string

    No

    The URL of the playback file.

    http://****/atestObject****.m3u8
    ResourceId

    string

    No

    The VOD file ID.

    a2b8e671-2fe5-4642-a2ec-bf93880e****
    Duration

    integer

    No

    The playback duration of a single show. Unit: seconds.

    Note

    • You can set only one of RepeatTimes and Duration.

    • This parameter is required when ResourceType is set to live.

    20
    RepeatTimes

    integer

    No

    The number of times a single show is repeated. Default value: 0.

    Note

    • You can set only one of RepeatTimes and Duration.- RepeatTimes specifies the number of repetitions. For example, -1 means infinite repetition, 0 means the show is repeated 0 times (played once), 1 means the show is repeated 1 time (played twice), and so on.

    0
    Spot

    integer

    No

    The position in the playlist where the show is inserted. Positions start 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 batch. Valid values:

    • true: Batch addition.

    • false: Single addition.

    Note

    If this parameter is not specified or left empty, single addition is used.

    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 failure reasons.

    failedList[Show1, Show2...]
    successfulShowIds

    string

    The list of show IDs 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.