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

Lists one-click video production nodes that meet conditional requirements and supports conditional query based on node type, status, and other conditions.

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

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
JobId	string	No	The ID of the one-click video production job.	**d80e4e4044975745c14b**
JobType	string	No	The job type. Valid values: Script: script-based material editing Smart_Mix: intelligent material editing Valid values: Script : Script-based material editing. Smart_Mix : Intelligent material editing.	Script
Status	string	No	The job status. Valid values: Finished: The job is completed. Init: The job is initialized. Failed: The job failed. Processing: The job is being processed. Valid values: Finished : The job is completed. Init : The job is initialized. Failed : The job failed. Processing : The job is being processed.	Finished
StartTime	string	No	The start time. The time is displayed in UTC. Format: yyyy-MM-ddTHH:mm:ssZ.	2022-02-02T00:00:00Z
EndTime	string	No	The end time. The time is displayed in UTC. Format: yyyy-MM-ddTHH:mm:ssZ.	2023-06-05T15:59:59Z
SortBy	string	No	The sorting order of the query results. Valid values: desc: sorts the results in descending order of creation time. This is the default value. asc: sorts the results in ascending order of creation time. Valid values: asc : Ascending order by creation time. desc : Descending order by creation time.	desc
NextToken	string	No	The token that indicates the position from which the current call starts to read data. An empty value indicates that all data has been read.	mRZkKAovub0xWVfH14he4Q==
MaxResults	integer	No	The maximum number of entries to return for the current request.	100

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	Id of the request	****3B-0E1A-586A-AC29-742247****
EditingBatchJobList	array<object>	The list of one-click video production jobs.
	object	The list of one-click video production jobs.
JobId	string	The ID of the one-click video production job.	****7ecbee4c6d9b8474498e****
InputConfig	string	The input configuration for user synthesis.	{ "MediaGroupArray": [{ "MediaArray": [ "**9d46c886b45481030f6e", "6c886b4549d481030f6e" ] }, { "MediaArray": [ "d46c886810b454930f6e", "4549d886810b46c30f6e**" ] }], "TitleArray": [ "Hema Fresh in Huilongguan is now open"], "SpeechTextArray": [ "A new Hema Fresh store has opened in the nearby mall, and today is its first day of business"] }
EditingConfig	string	The editing configurations. For more information about the structure, see EditingConfig.	{ "MediaConfig": { "Volume": 0 }, "SpeechConfig": { "Volume": 1 }, "BackgroundMusicConfig": { "Volume": 0.3 } }
OutputConfig	string	The output configurations. 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 job status. Valid values: Finished : The job is completed. Init : The job is initialized. Failed : The job failed. Processing : The job is being processed.	Finished
UserData	string	The custom settings in JSON format. The maximum length is 512 bytes. You can configure a custom callback URL.	{"NotifyAddress":"http://xx.xx.xxx"}, {"NotifyAddress":"https://xx.xx.xxx"}, or {"NotifyAddress":"ice-callback-demo"}
Extend	string	The extended information of the job.	{}
CreateTime	string	The creation time. The time is displayed in UTC.	2023-06-09T06:36:48Z
ModifiedTime	string	The last modification time. The time follows the ISO 8601 standard and is displayed in UTC (ending with Z).	2023-06-09T06:37:58Z
CompleteTime	string	The completion time. Format: yyyy-MM-ddTHH:mm:ssZ (UTC).	2023-06-09T06:38:09Z
JobType	string	The job type. Valid values: Script : Script-based material editing. Smart_Mix : Intelligent material editing.	Script
NextToken	string	The pagination token for the next query.	8EqYpQbZ6Eh7+Zz8DxVYoQ==
MaxResults	integer	The number of entries per page. Maximum value: 100. Default value: 10.	100

Examples

Success response

JSON format

{
  "RequestId": "******3B-0E1A-586A-AC29-742247******",
  "EditingBatchJobList": [
    {
      "JobId": "******7ecbee4c6d9b8474498e******",
      "InputConfig": "{\n  \"MediaGroupArray\": [{\n      \"MediaArray\": [\n        \"****9d46c886b45481030f6e****\",\n        \"****6c886b4549d481030f6e****\" ]\n    }, {\n      \"MediaArray\": [\n        \"****d46c886810b454930f6e****\",\n        \"****4549d886810b46c30f6e****\" ]\n  }],\n  \"TitleArray\": [\n      \"Hema Fresh in Huilongguan is now open\"],\n  \"SpeechTextArray\": [\n      \"A new Hema Fresh store has opened in the nearby mall, and today is its first day of business\"]\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\"}, {\"NotifyAddress\":\"https://xx.xx.xxx\"}, or {\"NotifyAddress\":\"ice-callback-demo\"}",
      "Extend": "{}",
      "CreateTime": "2023-06-09T06:36:48Z",
      "ModifiedTime": "2023-06-09T06:37:58Z",
      "CompleteTime": "2023-06-09T06:38:09Z\n",
      "JobType": "Script"
    }
  ],
  "NextToken": "8EqYpQbZ6Eh7+Zz8DxVYoQ==",
  "MaxResults": 100
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.