All Products
Search

This Product

    ApsaraVideo Live:AddLiveRecordVodConfig

    Document Center

    ApsaraVideo Live:AddLiveRecordVodConfig

    Last Updated:Jun 16, 2026

    Adds a live-to-VOD configuration to store recordings in ApsaraVideo VOD.

    Operation description

    If you compose or transcode recorded videos, video processing fee is charged in ApsaraVideo VOD. For details, see Billing of video editing and Billing of video transcoding.

    QPS limit

    This API is limited to 1,000 queries per minute for each account. If you exceed this limit, API calls are throttled, which can affect your business.

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

    create

    *Domain

    acs:cdn:*:{#accountId}:domain/{#DomainName}

    None

    None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example

    RegionId

    string

    No

    The region ID.

    cn-shanghai

    DomainName

    string

    Yes

    The streaming domain.

    Make sure that ApsaraVideo VOD is activated in the same region as the live center of the streaming domain.

    example.com

    AppName

    string

    Yes

    The AppName of the live stream. You can find the AppName on the stream management page.

    testName

    StreamName

    string

    No

    The name of the stream. You can find the StreamName on the stream management page.

    stream

    VodTranscodeGroupId

    string

    No

    Important

    This parameter is invalid if RecordFormat is specified.

    The ID of the ApsaraVideo VOD transcoding template group for transcoding the recording files.

    e2d796d3bb5fd8049d32bff62f94****

    CycleDuration

    integer

    No

    The maximum duration of each recording file. Unit: seconds. Default value: 3600. Range: 300 to 21600.

    300

    AutoCompose

    string

    No

    Important

    This parameter is invalid if RecordFormat is specified.

    Specifies whether to automatically compose multiple recording files into a single video. Valid value:

    • ON: enable automatic composition.

    Enabling this feature requires the ComposeVodTranscodeGroupId parameter.

    ON

    SpaceId

    string

    No

    The ID of the ApsaraVideo VOD application space. You can find the ID in the ApsaraVideo VOD console or by calling the ListAppInfo operation. This parameter is required only if you have enabled application spaces.

    app-1000000

    StorageLocation

    string

    No

    The storage location.

    ****-tjptr2vatm.oss-cn-shanghai.aliyuncs.com

    ComposeVodTranscodeGroupId

    string

    No

    Important

    This parameter is invalid if RecordFormat is specified.

    The ID of the ApsaraVideo VOD transcoding template group for transcoding the composed video created by automatic composition.

    This parameter is required only if AutoCompose is set to ON.

    *****

    OnDemand

    integer

    No

    The trigger mode of live stream recording. Valid values:

    • 0 (default): Automatic recording.

    • 1: Triggered by callback notifications of on-demand recording.

    • 2: Triggered by corresponding parameters in the stream ingest URL.

    • 7: Triggered manually. By default, recording is disabled. You can call the RealTimeRecordCommand operation to manually start or stop recording.

    0

    RecordContent

    string

    No

    The content to record. Valid values:

    • raw (default): Records the source stream.

    • transcode: Records the transcoded streams.

    To record both the source stream and transcoded streams, separate the values with a comma (,), for example, raw,transcode.

    Note

    TranscodeTemplates is required if transcode is specified.

    raw

    DelayTime

    integer

    No

    The reconnect timeout, in seconds. If a stream is interrupted but recovers within this window, the new content is automatically appended to the exisiting recording file. Otherwise, the previous session is considered ended, and a new recording file will be created. Valid values: 15 to 21600.

    180

    RecordFormat

    array<object>

    No

    A list of format-specific recording configurations.

    object

    No

    The format-specific recording configuration.

    Format

    string

    No

    The recording format. Valid values:

    • m3u8

    • flv

    • mp4

    m3u8

    SliceDuration

    integer

    No

    The duration of a TS segment, in seconds.

    This parameter is valid only if RecordFormat.N.Format is set to m3u8.

    The value must be an integer from 5 to 30. The default is 30.

    30

    AutoCompose

    string

    No

    Specifies whether to enable automatic composition.

    Valid values:

    • ON: Enable.

    • OFF: Disable.

    ON

    VideoProcess

    string

    No

    The video to process. Valid values:

    • origin (default): Processes the source recording files.

    • compose: Processes the composed video.

    To process both the source recording files and the composed video, separate the values with a comma (,), for example, origin,compose.

    origin

    ProcessMethod

    string

    No

    The video processing method. Valid values:

    • transcode: Processes the video by using a transcoding template group set in ApsaraVideo VOD.

    • workflow: Processes the video by using a workflow set in ApsaraVideo VOD.

    transcode

    ProcessTemplateId

    string

    No

    The ID of the transcoding template group or workflow to use for video processing.

    The ID must correspond to the specified ProcessMethod. For example, if ProcessMethod is transcode, this parameter must be the ID of a transcoding template group.

    e2d796d3bb5fd8049d32bff62f94****

    Tags

    string

    No

    The video category.

    sports

    TranscodeTemplates

    array

    No

    The transcoding templates configured in ApsaraVideo Live. It specifies which transcoded streams to record.

    string

    No

    • You can specify up to 10 templates.

    • If RecordContent includes transcode, this parameter is required.

    • To record all transcoded streams, set TranscodeTemplates.1 to the wildcard character (*).

    • You cannot set this parameter to raw because it is a reserved value.
      You can specify multiple templates by using the TranscodeTemplates.N format, where N is an integer starting from 1. For example, TranscodeTemplates.1=sd and TranscodeTemplates.2=hd.

    sd

    Response elements

    Element

    Type

    Description

    Example

    object

    The data returned.

    RequestId

    string

    The request ID.

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

    Examples

    Success response

    JSON format

    {
  "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F****"
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description

    400

    ConfigAlreadyExists

    Config has already exist.

    400

    CommomLiveRcordConfigExisted

    Commom liverecord config has already exist.

    400

    InvalidAutoCompose.Malformed

    Specified parameter AutoCompose is not valid.

    400

    InvalidAutoComposeAndComposeVodTranscodeGroupId.Malformed

    Specified parameter AutoCompose and ComposeVodTranscodeGroupId is not valid, must both empty or input

    400

    InvalidParam

    %s.

    Parameter verification failed

    500

    InternalError

    The request processing has failed due to backend service exception.

    403

    InvalidRegion.Conflict

    Specified parameter StorageLocation and Region is not match

    404

    InvalidStorage.NotFound

    Specified parameter StorageLocation is not exist

    404

    InvalidTemplateGroupId.NotFound

    Specified parameter vodTranscodeGroupId or composeVodTranscodeGroupId is not exist

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.