Configures the Live-to-VOD feature.

Usage notes

You can call this operation to configure the Live-to-VOD feature to store recordings in the media library of ApsaraVideo VOD.

Note You cannot configure the Live-to-VOD feature by using a Finance Cloud account.

QPS limit

You can call this operation up to 1,000 times per minute per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see QPS limit on an API operation in ApsaraVideo Live.


OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes AddLiveRecordVodConfig

The operation that you want to perform. Set the value to AddLiveRecordVodConfig.

DomainName String Yes

The main streaming domain.

AppName String Yes testName

The name of the application to which the live stream belongs.

StreamName String No stream

The name of the live stream.

VodTranscodeGroupId String Yes e2d796d3bb5fd8049d32bff62f94****

The ID of the transcoding template group in ApsaraVideo VOD.

CycleDuration Integer No 300

The duration of the recording period. Unit: seconds. Valid values: 300 to 21600. Default value: 3600.

AutoCompose String No OFF

Specifies whether to enable automatic merging. Valid values:

  • ON: enables automatic merging. If you set this parameter to ON, you must also specify the ComposeVodTranscodeGroupId parameter.
  • OFF: disables automatic merging.
Note If you enable automatic merging, the VOD files created from live streams are automatically merged. During the process, the editing and production feature of ApsaraVideo VOD is used. For information about the billing of this feature, see Billing of editing and production.
StorageLocation String No ****

The storage location.

ComposeVodTranscodeGroupId String No *****

The ID of the transcoding template group in ApsaraVideo VOD that is used to transcode the video file, into which the VOD files are automatically merged.

  • This parameter is required only if you set the AutoCompose parameter to ON.
  • For more information about automatic merging and transcoding, see FAQ about Live-to-VOD.
  • For more information about the billing of transcoding in ApsaraVideo VOD, see Billing of media transcoding.

Response parameters

Parameter Type Example Description
RequestId String 16A96B9A-F203-4EC5-8E43-CB92E68F4CD8

The ID of the request.


Sample requests

&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK

<?xml version="1.0" encoding="UTF-8" ?>

JSON format

HTTP/1.1 200 OK

  "RequestId" : "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8"

Error codes

HttpCode Error code Error message Description
400 ConfigAlreadyExists Config has already exist. The error message returned because the configuration already exists.

For a list of error codes, see Service error codes.