AddLiveStreamTranscode

Operation description

Using the live stream transcoding feature incurs transcoding fees, which are calculated based on the transcoding standard, resolution specification, and total transcoding length. For billing rules, see Live stream transcoding fees.
First obtain the user KMS master key ID through Key Management Service (KMS), and then invoke this operation to add default transcoding configuration information. Currently, this operation supports only two types of transcoding templates: standard quality templates and Narrowband HD™ transcoding templates.
Alibaba Cloud KMS provides default keys for server-side encryption of cloud services at no cost, and no instance purchase is required. However, if you need to build a custom application cryptographic solution, use the credential feature, or manage the key lifecycle, you must purchase a software or hardware key management instance. For billing details, see Billing.

QPS limit

The single-user QPS limit for this operation is 30 calls per second. If the limit is exceeded, API calls are throttled, which may affect your business. Invoke this operation appropriately.

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

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID. When using SDK 2.0, set this parameter to the region ID that corresponds to the service registration endpoint. When using SDK 1.0, ignore this parameter.	cn-shanghai
Domain	string	Yes	The streaming domain of the streamer.	example.com
App	string	Yes	The name of the application to which the stream belongs. The value of App must be the same as the AppName in the ingest URL for the transcoding template to take effect. The value can be up to 256 characters in length and can contain digits, letters, hyphens (-), and underscores (_). App also supports a single asterisk () as the value, which matches any string including an empty string. Note* If a transcoding template with App set to a single asterisk () is configured: when a user pulls a transcoded stream, the system first matches the transcoding template whose App value is the same as the AppName in the ingest URL. If no such template exists, the system matches the transcoding template with App set to a single asterisk ().	liveApp****
Template	string	Yes	The transcoding template. Valid values: Standard quality templates: lld: low definition. lsd: standard definition. lhd: high definition. lud: ultra-high definition. Narrowband HD™ transcoding templates: ld: low definition. sd: standard definition. hd: high definition. ud: ultra-high definition.	lsd
EncryptParameters	string	No	The encryption configuration. JSON format. The fields are described as follows: EncryptType: the encryption type. Set the value to aliyun. KmsKeyID: the user KMS master key ID. KmsKeyExpireInterval: the key rotation interval. Valid values: 60 to 3600. Unit: seconds.	{"EncryptType": "aliyun", "KmsKeyID":"afce5722-81d2-43c3-9930-7601da11****","KmsKeyExpireInterval":"3600"}
Lazy	string	No	Specifies whether to enable on-demand transcoding. Valid values: yes: enables on-demand transcoding. no: disables on-demand transcoding.	yes

Response elements

Element	Type	Description	Example
	object	The request ID.
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.