GetLiveEditingJob - Intelligent Media Services - Alibaba Cloud Documentation Center

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. You can call this operation to query only live editing jobs created within the past year.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

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:GetLiveEditingJob		All Resources ``	none	none

Request parameters

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

Response parameters

Parameter	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	long	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

Sample success responses

JSONformat

{
  "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

For a list of error codes, visit the Service error codes.