GetBatchMediaProducingJob-Intelligent Media Services(IMS)-阿里云帮助中心

Queries the details of batch intelligent one-click video production jobs, including the input parameters, task status, and the IDs and URLs of the produced media assets. This operation supports querying only task 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:GetBatchMediaProducingJob

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
JobId	string	No	The ID of the batch intelligent one-click video production job.	**b4549d46c88681030f6e**

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	**36-3C1E-4417-BDB2-1E034F**
EditingBatchJob	object	The batch intelligent one-click video production task information.
JobId	string	The task ID.	**b6b2750d4308892ac3330238**
InputConfig	string	The user synthesis output configuration. For more information about the structure, see InputConfig.	{ "MediaGroupArray": [{ "GroupName": "MediaGroup1", "MediaArray": [ "**9d46c886b45481030f6e", "6c886b4549d481030f6e" ] }, { "GroupName": "MediaGroup2", "MediaArray": [ "d46c886810b454930f6e", "4549d886810b46c30f6e**" ] }], "TitleArray": [ "Huilongguan Box Ma Xiansheng Opened", "Box of Ma Xiansheng has opened" ], "SpeechTextArray": [ "A new box of fresh horses has been opened in a nearby shopping mall. Today is the first day of opening." "There are a lot of people in the shopping mall. Snacks and drinks are relatively cheap. Come and have a look." ] }
EditingConfig	string	The editing-related configuration. For more information about the structure, see EditingConfig.	{ "MediaConfig": { "Volume": 0 }, "SpeechConfig": { "Volume": 1 }, "BackgroundMusicConfig": { "Volume": 0.3 } }
OutputConfig	string	The output configuration. For more information about the structure, see OutputConfig.	{ "MediaURL": "http://xxx.oss-cn-shanghai.aliyuncs.com/xxx_{index}.mp4", "Count": 20, "MaxDuration": 15, "Width": 1080, "Height": 1920, "Video": {"Crf": 27} }
Status	string	The task status. Valid values: Init: initialized Processing: processing Finished: finished	Finished
UserData	string	The user business and callback configurations. For more information about the structure, see UserData.	{"NotifyAddress":"http://xx.xx.xxx"}
Extend	string	The extended information. Field details: ErrorCode: the error code of the main task ErrorMessage: the error message of the main task	{ "ErrorCode": "InvalidMaterial.NotFound", "ErrorMessage": "The specified clips id not found:[\"**30d0b5e871eebb2ff7f6c75a**\"]" }
CreateTime	string	The time when the task was created. The time is displayed in UTC.	2024-06-13T08:47:07Z
ModifiedTime	string	The time when the task was modified. The time is displayed in UTC. Format: "YYYY-MM-DD'T'hh:mm:ss'Z'".	2024-06-13T08:57:07Z
CompleteTime	string	The time when the task was completed. The time is displayed in UTC. Format: "YYYY-MM-DD'T'hh:mm:ss'Z'".	2024-06-13T08:57:07Z
JobType	string	The task type. Valid values: Script: scripted automatic video production Smart_Mix: intelligent image and text matching video production Sports_Highlights: sports event highlights video production Screen_Media_Highlights: high-energy mashup video production Smart_Mix_Media_Select: intelligent matching - media selection Smart_Mix_Timeline_Organize: intelligent matching - timeline arrangement Screen_Media_Highlights_Media_Select: high-energy mashup - media selection Screen_Media_Highlights_Timeline_Organize: high-energy mashup - timeline arrangement Scene_Batch_Editing: multi-timeline batch synthesis	Script
SubJobList	array<object>	The list of one-click video production subtasks.
	object	The one-click video production subtask information.
MediaId	string	The ID of the produced media asset.	**1470b11171ee9d19e7e6c66a**
JobId	string	The subtask ID.	**8e81933d44e3ae69e2f81485**
MediaURL	string	The URL of the output video file.	http:/xxx.oss-cn-shanghai.aliyuncs.com/xxx_0.mp4
Status	string	The subtask status. Valid values: Init: initialized Processing: processing Success: successful Failed: failed	Success
ErrorCode	string	The error code returned when the subtask fails. This parameter is not returned if the subtask is successful.	InvalidMaterial.NotFound
ErrorMessage	string	The error message returned when the subtask fails. This parameter is not returned if the subtask is successful.	The specified clips id not found:["**30d0b5e871eebb2ff7f6c75a**"]
ProjectId	string	The ID of the cloud editing project.	**7cc47fe04eaa81bd853acb6a**
Duration	number	The duration of the produced video. Unit: seconds.	24.5
ExtendInput	string	The additional input. If JobType is set to Smart_Mix_Timeline_Organize or Screen_Media_Highlights_Timeline_Organize, the additional input is the media selection result. If JobType is set to Scene_Batch_Editing, the additional input is the list of editing project IDs.	["**7cc47fe04eaa81bd853acb6a", "04eaa7cc47fe81bd853acb6a**"]
ExtendOutput	string	The additional output. If JobType is set to Smart_Mix_Media_Select or Screen_Media_Highlights_Media_Select, the media selection result is additionally returned.	{ "textMatchMediaOutputList": [{ "textMatchMediaSentenceOutputList": [{ "duration": 3.366667, "matchClipList": [{ "clipId": "null-2", "endTime": 11.16, "mediaId": "**a0900f5071efbf1ce7e6c66a", "score": -0.253, "startTime": 8.04 }], "text": "A new box of fresh horses has been opened in the nearby shopping mall.", "textId": "0" }, { "duration": 1.566667, "matchClipList": [{ "clipId": "null-1", "endTime": 1.54, "mediaId": "a0900f5071efbf1ce7e6c66a**", "score": -0.2326, "startTime": 0 }], "text": "Today is the first day of opening", "textId": "0" } ] }] }

Examples

Success response

JSON format

{
  "RequestId": "****36-3C1E-4417-BDB2-1E034F****",
  "EditingBatchJob": {
    "JobId": "****b6b2750d4308892ac3330238****",
    "InputConfig": "{\n  \"MediaGroupArray\": [{\n      \"GroupName\": \"MediaGroup1\",\n      \"MediaArray\": [\n        \"****9d46c886b45481030f6e****\",\n        \"****6c886b4549d481030f6e****\" ]\n    }, {\n      \"GroupName\": \"MediaGroup2\",\n      \"MediaArray\": [\n        \"****d46c886810b454930f6e****\",\n        \"****4549d886810b46c30f6e****\" ]\n  }],\n  \"TitleArray\": [\n      \"Huilongguan Box Ma Xiansheng Opened\",\n      \"Box of Ma Xiansheng has opened\" ],\n  \"SpeechTextArray\": [\n      \"A new box of fresh horses has been opened in a nearby shopping mall. Today is the first day of opening.\"\n      \"There are a lot of people in the shopping mall. Snacks and drinks are relatively cheap. Come and have a look.\" ]\n}",
    "EditingConfig": "{\n  \"MediaConfig\": {\n      \"Volume\": 0\n  },\n  \"SpeechConfig\": {\n      \"Volume\": 1\n  },\n \"BackgroundMusicConfig\": {\n      \"Volume\": 0.3\n  }\n}",
    "OutputConfig": "{\n  \"MediaURL\": \"http://xxx.oss-cn-shanghai.aliyuncs.com/xxx_{index}.mp4\",\n  \"Count\": 20,\n  \"MaxDuration\": 15,\n  \"Width\": 1080,\n  \"Height\": 1920,\n  \"Video\": {\"Crf\": 27}\n}",
    "Status": "Finished",
    "UserData": "{\"NotifyAddress\":\"http://xx.xx.xxx\"}",
    "Extend": "{\n\t\"ErrorCode\": \"InvalidMaterial.NotFound\",\n\t\"ErrorMessage\": \"The specified clips id not found:[\\\"****30d0b5e871eebb2ff7f6c75a****\\\"]\"\n}",
    "CreateTime": "2024-06-13T08:47:07Z",
    "ModifiedTime": "2024-06-13T08:57:07Z\n",
    "CompleteTime": "2024-06-13T08:57:07Z\n",
    "JobType": "Script",
    "SubJobList": [
      {
        "MediaId": "****1470b11171ee9d19e7e6c66a****",
        "JobId": "****8e81933d44e3ae69e2f81485****",
        "MediaURL": "http:/xxx.oss-cn-shanghai.aliyuncs.com/xxx_0.mp4",
        "Status": "Success",
        "ErrorCode": "InvalidMaterial.NotFound",
        "ErrorMessage": "The specified clips id not found:[\"****30d0b5e871eebb2ff7f6c75a****\"]",
        "ProjectId": "****7cc47fe04eaa81bd853acb6a****",
        "Duration": 24.5
      }
    ],
    "ExtendInput": "[\"****7cc47fe04eaa81bd853acb6a****\", \"****04eaa7cc47fe81bd853acb6a****\"]",
    "ExtendOutput": "{\n\t\"textMatchMediaOutputList\": [{\n\t\t\"textMatchMediaSentenceOutputList\": [{\n\t\t\t\t\"duration\": 3.366667,\n\t\t\t\t\"matchClipList\": [{\n\t\t\t\t\t\"clipId\": \"null-2\",\n\t\t\t\t\t\"endTime\": 11.16,\n\t\t\t\t\t\"mediaId\": \"****a0900f5071efbf1ce7e6c66a****\",\n\t\t\t\t\t\"score\": -0.253,\n\t\t\t\t\t\"startTime\": 8.04\n\t\t\t\t}],\n\t\t\t\t\"text\": \"A new box of fresh horses has been opened in the nearby shopping mall.\",\n\t\t\t\t\"textId\": \"0\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"duration\": 1.566667,\n\t\t\t\t\"matchClipList\": [{\n\t\t\t\t\t\"clipId\": \"null-1\",\n\t\t\t\t\t\"endTime\": 1.54,\n\t\t\t\t\t\"mediaId\": \"****a0900f5071efbf1ce7e6c66a****\",\n\t\t\t\t\t\"score\": -0.2326,\n\t\t\t\t\t\"startTime\": 0\n\t\t\t\t}],\n\t\t\t\t\"text\": \"Today is the first day of opening\",\n\t\t\t\t\"textId\": \"0\"\n\t\t\t}\n\t\t]\n\t}]\n}"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.