GetMediaProducingJob - Intelligent Media Services - Alibaba Cloud Documentation Center

Queries the information about a media editing and production job. The requested information includes the state, timeline, template, and data of the job. You can call this operation to query only media editing and production 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:GetMediaProducingJob		All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
JobId	string	No	The ID of the media editing and production job.	**cdb3e74639973036bc84**

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	**83B7-7F87-4792-BFE9-63CD2137**
MediaProducingJob	object	The information about the online editing project.
JobId	string	The ID of the media editing and production job.	**cdb3e74639973036bc84**
ProjectId	string	The ID of the online editing project.	**fddd7748b58bf1d47e95**
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
Timeline	string	The timeline of the media editing and production job.	{"VideoTracks":[{"VideoTrackClips":[{"MediaId":"**4d7cf14dc7b83b0e801c"},{"MediaId":"4d7cf14dc7b83b0e801c**"}]}]}
TemplateId	string	The ID of the template used by the media editing and production job.	**6e76134d739cc3e85d3e**
ClipsParam	string	The template parameters of the media editing and production job.	{"VideoArray":["**05512043f49f697f7425","05512043f49f697f7425","05512043f49f697f7425**"]}
Duration	float	The duration of the output file. Note: This parameter has a value if the job is successful and the output file is an audio or video file.	30.500000
CreateTime	string	The time when the media editing and production 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
CompleteTime	string	The time when the media editing and production job was complete. 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
ModifiedTime	string	The time when the media editing and production 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
Status	string	The state of the media editing and production job. Valid values: Init Queuing Processing Success Failed	Failed
Code	string	The response code Note: Pay attention to this parameter if the job failed.	ExceededMaximumValue
Message	string	The returned message. Note: Pay attention to this parameter if the job failed.	The specified "Width_Height" has exceeded maximum value.
VodMediaId	string	The media asset ID of the output file in ApsaraVideo VOD if the output file is stored in ApsaraVideo VOD.	**332c5b0cc6ba49eab379**
UserData	string	The user-defined data in the JSON format.	{"NotifyAddress":"http://xx.xx.xxx","Key":"Valuexxx"}
SubJobMaterials	string	The materials of the media editing and production job if the job is a subjob of a quick video production job, including the broadcast text and title.	{"Title": "Title", "SpeechText": "Broadcast text of a quick video production job"}

Examples

Sample success responses

JSONformat

{
  "RequestId": "****83B7-7F87-4792-BFE9-63CD2137****",
  "MediaProducingJob": {
    "JobId": "****cdb3e74639973036bc84****",
    "ProjectId": "****fddd7748b58bf1d47e95****",
    "MediaId": "****0cc6ba49eab379332c5b****",
    "MediaURL": "http://example-bucket.oss-cn-shanghai.aliyuncs.com/example2.mp4",
    "Timeline": "{\"VideoTracks\":[{\"VideoTrackClips\":[{\"MediaId\":\"****4d7cf14dc7b83b0e801c****\"},{\"MediaId\":\"****4d7cf14dc7b83b0e801c****\"}]}]}",
    "TemplateId": "****6e76134d739cc3e85d3e****",
    "ClipsParam": "{\"VideoArray\":[\"****05512043f49f697f7425****\",\"****05512043f49f697f7425****\",\"****05512043f49f697f7425****\"]}",
    "Duration": 30.5,
    "CreateTime": "2020-12-23T13:33:40Z",
    "CompleteTime": "2020-12-23T13:33:52Z",
    "ModifiedTime": "2020-12-23T13:33:49Z",
    "Status": "Failed",
    "Code": "ExceededMaximumValue",
    "Message": "The specified \"Width_Height\" has exceeded maximum value.",
    "VodMediaId": "****332c5b0cc6ba49eab379****",
    "UserData": "{\"NotifyAddress\":\"http://xx.xx.xxx\",\"Key\":\"Valuexxx\"}",
    "SubJobMaterials": "{\"Title\": \"Title\", \"SpeechText\": \"Broadcast text of a quick video production job\"}\n"
  }
}

Error codes

HTTP status code	Error code	Error message
400	InvalidParameter	The specified parameter \ is not valid.
404	JobNotFound	The specified job not found

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

Change history

Change time	Summary of changes	Operation
2024-01-26	The Error code has changed. The response structure of the API has changed	View Change Details
2024-01-03	The Error code has changed. The response structure of the API has changed	View Change Details
2021-11-25	The Error code has changed. The response structure of the API has changed	View Change Details