All Products
Search

This Product

    ApsaraVideo Live:AddLiveStreamTranscode

    Document Center

    ApsaraVideo Live:AddLiveStreamTranscode

    Last Updated:Dec 29, 2025

    Adds a transcoding configuration for a streaming domain.

    Operation description

    • Live stream transcoding is a paid feature. Fees are based on the transcoding standard, resolution, and total transcoding length. For more information, see Billing of live stream transcoding.

    • To enable encryption, you must first obtain a customer master key (CMK) ID from Key Management Service (KMS). This operation supports only standard and Narrowband HD™ transcoding templates.

    • Alibaba Cloud KMS provides free server-side encryption with default keys. For advanced needs, such as custom encryption policies, key lifecycle controls, or centralized secrets management, you need to purchase dedicated software or hardware KMS instances. For billing information, see Billing of KMS.

    QPS limits

    You can call this operation up to 30 times per second per account. Requests that exceed this limit are dropped and you may experience service interruptions.

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

    create

    *Domain

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

    None

    None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example

    RegionId

    string

    No

    The region ID.

    cn-shanghai

    Domain

    string

    Yes

    The streaming domain.

    example.com

    App

    string

    Yes

    The AppName of the live stream. Max length: 256 characters. Supports letters, digits, underscores (_), and hyphens (-).

    • The value must match the AppName in the ingest URL for the configuration to take effect.

    • An asterisk (*) can be used as a wildcard to match any AppName.

    Note

    When a transcoded stream is requested, the system first tries to match a configuration with the exact AppName. If not found, it then tries to match a wildcard configuration where App is *.

    liveApp****

    Template

    string

    Yes

    The transcoding template. Valid values:

    • Standard transcoding:

      • lld: low definition.

      • lsd: standard definition.

      • lhd: high definition.

      • lud: ultra-high definition.

    • Narrowband HD™ transcoding:

      • ld: low definition.

      • sd: standard definition.

      • hd: high definition.

      • ud: ultra high definition.

    lsd

    EncryptParameters

    string

    No

    The encryption settings, formatted as a JSON string.

    • EncryptType: The encryption type. Set the value to aliyun.

    • KmsKeyID: The ID of the customer master key (CMK) in Key Management Service (KMS).

    • KmsKeyExpireInterval: The key rotation period. Unit: seconds. Valid values: 60 to 3600.

    {"EncryptType": "aliyun", "KmsKeyID":"afce5722-81d2-43c3-9930-7601da11****","KmsKeyExpireInterval":"3600"}

    Lazy

    string

    No

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

    • yes: Transcoding only starts when the first viewer requests this transcoded stream.

    • no: Transcoding starts immediately after the stream is published.

    yes

    Response elements

    Element

    Type

    Description

    Example

    object

    The data returned.

    RequestId

    string

    The request ID.

    16A96B9A-F203-4EC5-8E43-CB92E68F4CD8

    Examples

    Success response

    JSON format

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

    Error codes

    HTTP status code

    Error code

    Error message

    Description

    400

    InvalidParameters

    %s Please check and try again later.

    Exception parameter exists, please check and try again.

    400

    ConfigAlreadyExists

    %s Please check and try again later.

    Configuration already exists, please check and try again.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.