All Products
Search

This Product

    ApsaraVideo Live:AddCasterEpisode

    Document Center

    ApsaraVideo Live:AddCasterEpisode

    Last Updated:Aug 14, 2025

    Adds an episode to a production studio.

    Operation description

    Before you call this operation, obtain the ID of the production studio. The ID is generated when the production studio is created.

    • If you create a production studio by calling the CreateCaster operation, check the value of the returned CasterId parameter.

    • If you create a production studio in the LIVE console, go to LIVE Console > Production Studio > Production Studio to view the name of the production studio.

    Note

    The name of the production studio in the production studio list serves as the production studio ID.

    QPS limits

    The queries per second (QPS) limit for this operation is 4 for each account. API calls that exceed this limit are throttled, which may affect your business. Plan your calls accordingly.

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

    create

    *Caster

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

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    RegionId

    string

    No

    The region ID.

    cn-shanghai
    ComponentId

    array

    No

    A list of component IDs. The components are layered from bottom to top in the specified order.

    If you add a component by calling the AddCasterComponent operation, check the value of the ComponentId parameter that is returned.

    • This parameter is required and applies only when the resource type is Component.

    • This parameter is optional when the resource type is Resource. If you specify this parameter, the component is attached to the video source and they are switched synchronously.

    Note

    N specifies the sequence number of a component ID. For example, ComponentId.1 specifies the first component ID and ComponentId.2 specifies the second component ID.

    ["a2b8e671-2fe5-4642-a2ec-bf93880e****"]

    string

    No

    The component ID.

    21926b36-7dd2-4fde-ae25-51b5bc8e****
    CasterId

    string

    Yes

    The ID of the production studio.

    • If you create a production studio by calling the CreateCaster operation, check the value of the CasterId parameter that is returned.

    • If you create a production studio in the LIVE console, go to the LIVE Console> Production Studio > Production Studio page to view the ID.

    Note

    The name of the production studio in the production studio list serves as the production studio ID.

    LIVEPRODUCER_POST-cn-0pp1czt****
    EpisodeType

    string

    Yes

    The node type. Valid values:

    • Resource: A video source. If you set this parameter to Resource, you must also specify the ResourceId and SwitchType parameters.

    • Component: A component.

    Resource
    EpisodeName

    string

    No

    The name of the episode.

    episode_1
    ResourceId

    string

    No

    The ID of the video source.

    Important

    This parameter is required and applies only when EpisodeType is set to Resource.

    If you add a video source by calling the AddCasterVideoResource operation, check the value of the ResourceId parameter that is returned.

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

    string

    Yes

    The start time. The time is in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

    2016-06-29T08:00:00Z
    EndTime

    string

    Yes

    The end time. The time is in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

    2016-06-29T09:10:00Z
    SwitchType

    string

    Yes

    The switch policy. Valid values:

    Important

    This parameter applies only when EpisodeType is set to Resource.

    • TimeFirst: Time first.

    • ContentFirst: Content first.

    Note

    For more information about video sources, see Add a video source.

    TimeFirst

    Response parameters

    Parameter

    Type

    Description

    Example

    object

    EpisodeId

    string

    The ID of the episode. This ID can be used as a request parameter to query the episode list, modify an episode, or delete an episode.

    21926b36-7dd2-4fde-ae25-51b5bc8e****
    RequestId

    string

    The request ID.

    16A96B9A-F203-4EC5-8E43-CB92E68F****

    Examples

    Success response

    JSON format

    {
  "EpisodeId": "21926b36-7dd2-4fde-ae25-51b5bc8e****",
  "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F****"
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    400 MissingParameter %s
    400 InvalidParameter.Malformed %s
    400 SwitchTypeInvalid.Malformed %s
    400 IncorrectStartTime %s
    400 IncorrectEndTime %s
    400 EpisodeConflict.Malformed %s
    400 InvalidCasterId.Malformed %s
    401 IllegalOperation %s
    500 InternalError %s
    404 InvalidCaster.NotFound %s
    404 InvalidResource.NotFound %s
    404 InvalidComponent.NotFound %s

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.