Intelligent Media Services:GetLiveEditingJob - Intelligent Media Services - Alibaba Cloud - Intelligent Media Services

Queries the information about a live editing job. The requested information includes the state, timeline, and template of the job, the ID and URL of the output file, and the configurations of the job. Query only live editing jobs created within the past year.

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

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
JobId	string	No	The ID of the live editing job.	**d80e4e4044975745c14b**

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	**36-3C1E-4417-BDB2-1E034F**
LiveEditingJob	object	The information about the live editing job.
JobId	string	The ID of the live editing job.	**cdb3e74639973036bc84**
ProjectId	string	The ID of the live editing project.	**fddd7748b58bf1d47e95**
Status	string	The state of the live editing job. Valid values: Init, Queuing, Processing, Success, and Failed.	Success
Clips	string	The clips.	[{\"StartTime\": \" 2021-06-21T08:01:00Z\", \"EndTime\": \" 2021-06-21T08:03:00Z\" }]
UserData	string	The user-defined data.	{"key": "value'}
CreationTime	string	The time when the live editing job was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2020-12-23T13:33:40Z
ModifiedTime	string	The time when the live editing job was last modified. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2020-12-23T13:33:49Z
CompleteTime	string	The time when the live editing job was completed. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2020-12-23T13:33:52Z
MediaId	string	The media asset ID of the output file.	**0cc6ba49eab379332c5b**
MediaURL	string	The URL of the output file.	http://example-bucket.oss-cn-shanghai.aliyuncs.com/example2.mp4
Code	string	The response code. Note: Pay attention to this parameter if the job failed.	InvalidParameter
Message	string	The returned message. Note: Pay attention to this parameter if the job failed.	The specific parameter LiveStreamConfig is not valid.
LiveStreamConfig	object	The live editing configurations.
AppName	string	The name of the application to which the live stream belongs.	app
DomainName	string	The domain name of the live stream.	domain.com
StreamName	string	The name of the live stream.	streamName
MediaProduceConfig	object	The production configurations.
Mode	string	The editing mode. Default value: Accurate.	Accurate
OutputMediaConfig	object	The storage configurations of the output file.
MediaURL	string	The URL of the output file.	https://testice-testbucket.oss-cn-shanghai.aliyuncs.com/test.mp4
StorageLocation	string	If OutputMediaTarget is set to vod-media, this parameter indicates the storage location of the media asset in ApsaraVideo VOD. The storage location is the path of the file in ApsaraVideo VOD, excluding the prefix http://. Example: outin-xxxxxx.oss-cn-shanghai.aliyuncs.com.	outin-xxxxxx.oss-cn-shanghai.aliyuncs.com
FileName	string	If OutputMediaTarget is set to vod-media, this parameter indicates the file name of the output file. The value contains the file name extension but not the path.	test.mp4
Width	integer	The width of the output file. You can leave this parameter empty. The default value is the maximum width of the input materials.	640
Height	integer	The height of the output file. You can leave this parameter empty. The default value is the maximum height of the input materials.	480
Bitrate	integer	The bitrate of the output file. Unit: Kbit/s. You can leave this parameter empty. The default value is the maximum bitrate of the input materials.	1000
VodTemplateGroupId	string	The ID of the VOD transcoding template group. If VOD transcoding is not required, set the value to VOD_NO_TRANSCODE.	VOD_NO_TRANSCODE

Examples

Success response

JSON format

{
  "RequestId": "****36-3C1E-4417-BDB2-1E034F****",
  "LiveEditingJob": {
    "JobId": "****cdb3e74639973036bc84****",
    "ProjectId": "****fddd7748b58bf1d47e95****",
    "Status": "Success",
    "Clips": "[{\\\"StartTime\\\": \\\" 2021-06-21T08:01:00Z\\\",  \\\"EndTime\\\": \\\" 2021-06-21T08:03:00Z\\\" }]",
    "UserData": "{\"key\": \"value'}",
    "CreationTime": "2020-12-23T13:33:40Z",
    "ModifiedTime": "2020-12-23T13:33:49Z",
    "CompleteTime": "2020-12-23T13:33:52Z",
    "MediaId": "****0cc6ba49eab379332c5b****",
    "MediaURL": "http://example-bucket.oss-cn-shanghai.aliyuncs.com/example2.mp4",
    "Code": "InvalidParameter",
    "Message": "The specific parameter LiveStreamConfig is not valid.",
    "LiveStreamConfig": {
      "AppName": "app",
      "DomainName": "domain.com",
      "StreamName": "streamName"
    },
    "MediaProduceConfig": {
      "Mode": "Accurate"
    },
    "OutputMediaConfig": {
      "MediaURL": "https://testice-testbucket.oss-cn-shanghai.aliyuncs.com/test.mp4",
      "StorageLocation": "outin-xxxxxx.oss-cn-shanghai.aliyuncs.com",
      "FileName": "test.mp4",
      "Width": 640,
      "Height": 480,
      "Bitrate": 1000,
      "VodTemplateGroupId": "VOD_NO_TRANSCODE"
    }
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.