All Products
Search

This Product

    ApsaraVideo Live:AddLiveRecordVodConfig

    Document Center

    ApsaraVideo Live:AddLiveRecordVodConfig

    Last Updated:Nov 14, 2024

    Adds a Live-to-VOD configuration to store recordings in the media library of ApsaraVideo VOD.

    Operation description

    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 limits.

    Debugging

    You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

    Authorization information

    The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

    • Operation: the value that you can use in the Action element to specify the operation on a resource.
    • Access level: the access level of each operation. The levels are read, write, and list.
    • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
      • The required resource types are displayed in bold characters.
      • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
    • Condition Key: the condition key that is defined by the cloud service.
    • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
    OperationAccess levelResource typeCondition keyAssociated operation
    live:AddLiveRecordVodConfigcreate
    *Domain
    acs:cdn:*:{#accountId}:domain/{#DomainName}
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    DomainNamestringYes

    The main streaming domain.

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

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

    		testName
    StreamNamestringNo

    The name of the live stream.

    		stream
    VodTranscodeGroupIdstringYes

    The ID of the transcoding template group in ApsaraVideo VOD.

    		e2d796d3bb5fd8049d32bff62f94****
    CycleDurationintegerNo

    The recording cycle. Unit: seconds. Valid values: 300 to 21600. Default value: 3600.

    		300
    AutoComposestringNo

    Specifies whether to enable automatic merging. If you set the value to ON, automatic merging is enabled and the ComposeVodTranscodeGroupId parameter is required. If you do not specify this parameter, automatic merging is disabled.

    Note If you enable automatic merging, the VOD files that are created from live streams are automatically merged by using the editing and production feature of ApsaraVideo VOD. For information about the billing of the feature, see Billing of value-added services.
    		ON
    StorageLocationstringNo

    The storage location.

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

    The ID of the transcoding template group in ApsaraVideo VOD that is used to transcode the video file. The video file is generated by merging the VOD files created from live streams.

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

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

    • 0 (default): disables on-demand recording.
    • 1: enables on-demand recording by using the HTTP callback method.
    		0

    Response parameters

    ParameterTypeDescriptionExample
    object

    The request ID.

    RequestIdstring

    The request ID.

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

    Examples

    Sample success responses

    JSONformat

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

    Error codes

    HTTP status codeError codeError message
    400ConfigAlreadyExistsConfig has already exist.
    400CommomLiveRcordConfigExistedCommom liverecord config has already exist.
    400InvalidAutoCompose.MalformedSpecified parameter AutoCompose is not valid.
    400InvalidAutoComposeAndComposeVodTranscodeGroupId.MalformedSpecified parameter AutoCompose and ComposeVodTranscodeGroupId is not valid, must both empty or input
    403InvalidRegion.ConflictSpecified parameter StorageLocation and Region is not match
    404InvalidStorage.NotFoundSpecified parameter StorageLocation is not exist
    404InvalidTemplateGroupId.NotFoundSpecified parameter vodTranscodeGroupId or composeVodTranscodeGroupId is not exist
    500InternalErrorThe request processing has failed due to backend service exception.

    For a list of error codes, visit the Service error codes.

    Change history

    Change timeSummary of changesOperation
    No change history