SubmitLiveTranscodeJob - - Alibaba Cloud Documentation Center

Submits a live stream transcoding job.

Operation description

When you submit a transcoding job that immediately takes effect, make sure that the input stream can be streamed.
When you submit a timed transcoding job, make sure that the input stream can be streamed before the specified time.

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

ice:SubmitLiveTranscodeJob

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Name	string	Yes	The name of the transcoding job.	task1
TemplateId	string	Yes	The template ID.	**96e8864746a0b6f3**
StartMode	integer	Yes	The start mode of the transcoding job. 0: The transcoding job immediately starts. 1: The transcoding job starts at the scheduled time.	0
StreamInput	object	Yes	The information about the input stream.
Type	string	Yes	The type of the input stream. The value can only be rtmp.	rtmp
InputUrl	string	Yes	The URL of the input stream.	rtmp://mydomain/app/stream1
TranscodeOutput	object	Yes	The information about the transcoding output.
Type	string	Yes	The type of the output stream. A value of LiveCenter indicates that the URL of the output stream is generated based on the domain name of ApsaraVideo Live. The value can only be LiveCenter.	LiveCenter
DomainName	string	No	The streaming domain name of ApsaraVideo Live.	mydomain
TimedConfig	object	No	The configuration of a timed transcoding job. This parameter is required if you set StartMode to 1.
StartTime	string	No	The start time of the transcoding job. Note: The time span between the start time and the current time cannot exceed seven days.	2022-02-21T00:00:00Z
EndTime	string	No	The stop time of the transcoding job. Note: The time span between the stop time and the current time cannot exceed seven days.	2022-07-20T08:20:32Z

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	****3B-0E1A-586A-AC29-742247****
JobId	string	The ID of the transcoding job.	**20b48fb04483915d4f2cd8ac**

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
403	Forbidden	User not authorized to operate on the specified resource.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.