Automate Edge Transcoding Jobs with the ApsaraVideo Live API - ApsaraVideo Live - Alibaba Cloud - ApsaraVideo Live

Operation description

This operation creates an edge transcoding task.
You must have permissions to access the edge transcoding service before calling this operation.

QPS limit

The QPS limit for this operation is 6,000 calls per minute per user. If the limit is exceeded, API calls are throttled, which may affect your business. Call this operation at a reasonable rate.

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

create

*Domain

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

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-shanghai
ClusterId	string	Yes	The data center ID. The specific value must be determined by convention after you submit a ticket or consult with the front-line team. For the ticket submission address, see Contact us.	****3b-4d18-395c-8106-ff21a6****
Name	string	Yes	The task name. Supports Chinese and English characters, digits, hyphens, and underscores. The maximum length is 255 English characters.	task1
TemplateId	string	Yes	The template ID.	**96e8864746a0b6f3**
StreamInput	string	Yes	The input stream URL.	rtmp://mydomain/app/stream1
StreamOutput	string	Yes	The output stream URL.	rtmp://testdomain/app/stream2

Response elements

Element	Type	Description	Example
	object
JobId	string	The edge transcoding task ID.	**20b48fb04483915d4f2cd8ac**
RequestId	string	The request ID.	****3B-0E1A-586A-AC29-742247****

Examples

Success response

JSON format

{
  "JobId": "****20b48fb04483915d4f2cd8ac****",
  "RequestId": "******3B-0E1A-586A-AC29-742247******"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter	%s.	Parameter error
400	MissingParameter	%s.	Missing parameter
403	OperationDenied	%s, please check and try again later.	Operation rejected, please check and try again.
404	TemplateNotFound	%s, please check and try again later.	The template does not exist. Please check and try again.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.