All Products
Search

This Product

    ApsaraVideo Live:AddLiveRecordVodConfig

    Document Center

    ApsaraVideo Live:AddLiveRecordVodConfig

    Last Updated:Nov 11, 2025

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

    Operation description

    You can call this operation to add a live-to-VOD configuration for storing recordings in the ApsaraVideo VOD media library.

    Note

    Alibaba Finance Cloud accounts do not support the live-to-VOD feature.

    QPS limit

    The queries per second (QPS) limit for this operation is 1,000 calls per minute per user. 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: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.

    Note

    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. View AppNames on the Stream Management page.

    testName

    StreamName

    string

    No

    The name of the stream. View StreamNames on the Stream Management page.

    stream

    VodTranscodeGroupId

    string

    Yes

    The ID of the ApsaraVideo VOD transcoding template group.

    e2d796d3bb5fd8049d32bff62f94****

    CycleDuration

    integer

    No

    The recording duration for each file. Unit: seconds. The default value is 3600. Valid values: 300 to 21600.

    300

    AutoCompose

    string

    No

    Specifies whether to enable the automatic composition feature. Set to ON to enable. When enabled, the multiple video files from the cyclical recording will be automatically merged into a single, complete video after the live stream ends. The ComposeVodTranscodeGroupId parameter is required when this is enabled.

    Note

    This feature uses the video editing capability of ApsaraVideo VOD. For billing information, see Editing and production.

    ON

    StorageLocation

    string

    No

    The storage address.

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

    ComposeVodTranscodeGroupId

    string

    No

    The ID of the ApsaraVideo VOD transcoding template group that is used to transcode the the single, composed video file that is generated after automatic composition.

    Note

    *****

    OnDemand

    integer

    No

    Specifies whether to enable on-demand recording. Valid values:

    • 0 (default): Disabled.

    • 1: Recording to VOD does not support on-demand recording. This value is generally not used.

    0

    Response elements

    Parameter

    Type

    Description

    Example

    object

    The response parameters.

    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

    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.