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.
Debugging
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.
Operation | Access level | Resource type | Condition key | Associated operation |
---|---|---|---|---|
ice:SubmitLiveTranscodeJob | *All Resources * |
| 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 |
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 parameters
Examples
Sample success responses
JSON
format
{
"RequestId": "******3B-0E1A-586A-AC29-742247******",
"JobId": "****20b48fb04483915d4f2cd8ac****"
}
Error codes
HTTP status code | Error code | Error message |
---|---|---|
403 | Forbidden | User not authorized to operate on the specified resource. |
For a list of error codes, visit the Service error codes.