All Products
Search

This Product

    ApsaraVideo Live:InitializeAutoShowListTask

    Document Center

    ApsaraVideo Live:InitializeAutoShowListTask

    Dernière mise à jour :Jul 16, 2026

    Creates a scheduled task.

    Operation description

    This operation allows you to configure a scheduled task to start and stop a playlist at specified times. Make sure that the parameters are set correctly when you call this operation.

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

    none

    *Caster

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

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    RegionId

    string

    No

    The region ID.

    cn-shanghai
    ResourceIds

    string

    No

    The list of video-on-demand media asset file IDs in the playlist. Currently, only MP4 video files from the video-on-demand platform are supported.

    A maximum of three programs are supported. Each program is played in the order of the list until EndTime, at which point playback automatically ends. This parameter is required. If it is missing, a MissingParameter error is returned.

    Note

    ["89e02xxxxfb349axxxxa0c350d**** ","6ae0xxxxxb349axxxxa0c350a****"]
    StartTime

    integer

    Yes

    The start timestamp. Unit: milliseconds.

    1645688994000
    EndTime

    integer

    Yes

    The end timestamp. Unit: milliseconds.

    1645688994000
    CasterConfig

    string

    Yes

    The production studio configuration. This includes:

    • (Required) CasterTemplate: the output resolution of the production studio.

    • (Optional) LiveTemplate: the list of output transcoding tasks.

    Note

    A JSON-formatted string. Use upper camel case (PascalCase) for the field names within the struct.

    {"CasterTemplate": "lp_ld","LiveTemplates":["lhd", "lsd","lud"]}
    DomainName

    string

    Yes

    The output streaming domain.

    example.aliyundoc.com
    CallBackUrl

    string

    No

    The callback URL.

    http://***.com/callback

    Response elements

    Element

    Type

    Description

    Example

    object

    CasterId

    string

    The production studio ID.

    Note

    This ID can be used as a request parameter for querying production studio stream URLs, starting the production studio, adding video resources to the production studio, adding layouts to the production studio, querying the layout list of the production studio, adding components to the production studio, and adding programs to the production studio.

    b4810848-bcf9-4aef-bd4a-e6bba2d9****
    RequestId

    string

    The request ID.

    16A96B9A-F203-4EC5-8E43-CB92E68F4CD8
    StreamList

    string

    The list of output addresses of the production studio.

    • videoFormat: the streaming URL format.

    • outputStreamUrl: the stream pulling URL.

    • transcodeConfig: the transcoding resolution description of the stream pulling URL.

    [{"videoFormat":"flv","outputStreamUrl":"http://example.aliyundoc.com","transcodeConfig":"original"}]

    Examples

    Success response

    JSON format

    {
  "CasterId": "b4810848-bcf9-4aef-bd4a-e6bba2d9****",
  "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8",
  "StreamList": "[{\"videoFormat\":\"flv\",\"outputStreamUrl\":\"http://example.aliyundoc.com\",\"transcodeConfig\":\"original\"}]"
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    400 InvalidParameter.PurchaseTime %s, please check and try again later. The parameter PurchaseTime is invalid, please check and try again.
    400 InvalidParameter.ExpireTime %s, please check and try again later. The parameter ExpireTime is invalid, please check and try again.
    400 MissingParameter %s. Missing parameter
    400 InvalidChargeType.Malformed %s, please check and try again later. The parameter ChargeType is invalid, please check and try again.
    400 InvalidChargeType.PostSupport %s, please check and try again later. ChargeType only supports post-paid, please check and try again.
    400 InvalidCasterTemplate.Malformed %s, please check and try again later. The parameter CasterTemplate is invalid, please check and try again.
    400 InvalidParameter.Malformed There are invalid parameters: %s. There are invalid parameters: %s.
    400 InvalidParameter.ChargeType %s, please check and try again later. The parameter ChargeType is invalid, please check and try again.
    400 InvalidPeriod.Malformed %s, please check and try again later. Invalid time interval, please check and try again.
    400 InvalidClientToken.Malformed %s, please check and try again later. The parameter ClientToken is invalid, please check and try again.
    400 IncorrectCasterStatus %s, please check and try again later. Guide station status error, please check and try again.
    400 InvalidCasterId.Malformed %s, please check and try again later. The parameter CasterId is invalid, please check and try again.
    400 InvalidUserId.Malformed %s, please check userId. The userId passed in is invalid, please check.
    400 InvalidParameter.StartTime %s, please check and try again later. The parameter StartTime is invalid, please check and try again.
    401 CasterNumberExceed %s, please check and try again later. The number of casters exceeds the limit. Please check and try again.
    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 IncorrectCasterStatus.EnableChannel %s, please check and try again later. Caster status does not support EnableChannel settings, please check and try again.
    404 InvalidParameter.NormType %s, please check and try again later. The parameter NormType is invalid, please check and try again.
    404 InvalidConfiguration.NotFound %s, please check and try again later. Configuration does not exist, please check and try again.
    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.
    408 CreateCaster.Timeout %s, please try again later. Call CreateCaster timed out, please try again later.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.