GetMediaProducingJob-阿里云帮助中心

Retrieves details for an editing and composition job, such as its task status, timeline, template, and data.

Operation description

Limitations

This API can only retrieve editing job data from 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:GetMediaProducingJob

get

*All Resource

*

None

Request parameters

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

Response elements

Element	Type	Description	Example
	object	The response object.
RequestId	string	The request ID.	**83B7-7F87-4792-BFE9-63CD2137**
MediaProducingJob	object	The details of the media producing job.
JobId	string	The job ID.	**cdb3e74639973036bc84**
ProjectId	string	The project ID.	**fddd7748b58bf1d47e95**
MediaId	string	The ID of the output media asset.	**0cc6ba49eab379332c5b**
MediaURL	string	The URL of the output media file.	http://example-bucket.oss-cn-shanghai.aliyuncs.com/example2.mp4
Timeline	string	The timeline of the media producing job.	{"VideoTracks":[{"VideoTrackClips":[{"MediaId":"**4d7cf14dc7b83b0e801c"},{"MediaId":"4d7cf14dc7b83b0e801c**"}]}]}
TemplateId	string	The ID of the template used for the job.	**6e76134d739cc3e85d3e**
ClipsParam	string	The clip parameters of the template used for the job.	{"VideoArray":["**05512043f49f697f7425","05512043f49f697f7425","05512043f49f697f7425**"]}
Duration	number	The duration of the output media. Important This parameter is returned only if the job is successful and the output is an audio or video file.	30.500000
CreateTime	string	The time in UTC when the media producing job was created, formatted as `YYYY-MM-DD'T'hh:mm:ss'Z'`.	2020-12-23T13:33:40Z
CompleteTime	string	The time in UTC when the media producing job was completed, formatted as `YYYY-MM-DD'T'hh:mm:ss'Z'`.	2020-12-23T13:33:52Z
ModifiedTime	string	The time in UTC when the media producing job was last modified, formatted as `YYYY-MM-DD'T'hh:mm:ss'Z'`.	2020-12-23T13:33:49Z
Status	string	The status of the media producing job. Valid values: `Init` (Initialized) `Queuing` (In queue) `Processing` (In progress) `Success` (Successful) `Failed` (Failed)	Failed
Code	string	The error code of the media producing job. Important This parameter is returned only if the job fails.	ExceededMaximumValue
Message	string	The error message of the media producing job. Important This parameter is returned only if the job fails.	The specified "Width_Height" has exceeded maximum value.
VodMediaId	string	The ID of the media asset in VOD (Video on Demand). This ID is returned if the job's output is stored in VOD.	**332c5b0cc6ba49eab379**
UserData	string	The user data, in JSON format.	{"NotifyAddress":"http://xx.xx.xxx","Key":"Valuexxx"}
SubJobMaterials	string	If the job is a subtask of a batch smart one-click video creation task, this parameter contains the subtask's materials, such as the title and speech script.	{"Title": "标题", "SpeechText": "批量智能一键成片口播文案"}
Progress	integer	The progress of the job. Valid values: 0 to 100.

Examples

Success response

JSON format

{
  "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\": \"标题\", \"SpeechText\": \"批量智能一键成片口播文案\"}",
    "Progress": 0
  }
}

Error codes

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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.