All Products
Search
Document Center

ApsaraVideo Live:AddLiveStreamTranscode

更新時間:Nov 14, 2024

Adds transcoding configurations for a streaming domain.

Operation description

You must obtain the customer master key (CMK) in Key Management Service (KMS) before you call this operation to add transcoding configurations. Only standard transcoding templates and Narrowband HD™ transcoding templates are supported for this operation.

QPS limits

You can call this operation up to 30 times per second 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.

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:AddLiveStreamTranscodecreate
*Domain
acs:cdn:*:{#accountId}:domain/{#DomainName}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DomainstringYes

The name of the main streaming domain.

example.com
AppstringYes

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

  • The transcoding template takes effect only if the value of this parameter is the same as the application name that is specified in the ingest URL. The name can be up to 256 characters in length and can contain digits, letters, hyphens (-), and underscores (_).
  • You can also set this parameter to an asterisk (*). Asterisks (*) can match any string, including an empty string.
Note If you configure a transcoding template for which App is set to an asterisk (*), the transcoding template is used only if no transcoding template for which App is set to the same value as AppName in the ingest URL exists.
liveApp****
TemplatestringYes

The transcoding template. Valid values:

  • Standard transcoding template:

    • lld: low definition
    • lsd: standard definition
    • lhd: high definition
    • lud: ultra-high definition
  • Narrowband HD™ transcoding template:

    • ld: low definition
    • sd: standard definition
    • hd: high definition
    • ud: ultra-high definition
lsd
EncryptParametersstringNo

The encryption configuration. The value is a JSON string. The following fields are included in the syntax:

  • EncryptType: the type of the encryption. Set the value to aliyun.
  • KmsKeyID: the ID of the CMK in KMS.
  • KmsKeyExpireInterval: the validity period of the CMK. Valid values: 60 to 3600. Unit: seconds.
{"EncryptType": "aliyun", "KmsKeyID":"afce5722-81d2-43c3-9930-7601da11****","KmsKeyExpireInterval":"3600"}
LazystringNo

Specifies whether to use the load-on-demand mechanism for transcoding. Default value: yes.

yes

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

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

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError message
400InvalidParameters%s
400ConfigAlreadyExists%s

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

Change history

Change timeSummary of changesOperation
No change history