Call ListBatchMediaProducingJobs to query media producing jobs - Intelligent Media Services - Alibaba Cloud - Intelligent Media Services

Queries a list of quick video production jobs based on conditions such as the job type and state.

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 quick video production job.	**d80e4e4044975745c14b**
JobType	string	No	The job type. Valid values: Script: script-based editing job that mixes media assets. Smart_Mix: intelligent editing job that mixes media assets. Valid values: Script : Smart_Mix :	Script
Status	string	No	The job state. Valid values: Finished Init Failed Processing Valid values: Finished : Init : Failed : Processing :	Finished
StartTime	string	No	The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.	2022-02-02T00:00:00Z
EndTime	string	No	The end of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.	2023-06-05T15:59:59Z
SortBy	string	No	The sorting parameter. Valid values: desc (default): sorted by creation time in descending order. asc: sorted by creation time in ascending order. Valid values: asc : desc :	desc
NextToken	string	No	The pagination token that is used in the next request to retrieve a new page of results.	mRZkKAovub0xWVfH14he4Q==
MaxResults	integer	No	The maximum number of entries to return.	100

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	****3B-0E1A-586A-AC29-742247****
EditingBatchJobList	array<object>	The queried quick video production jobs.
	object	The queried quick video production job.
JobId	string	The ID of the quick video production job.	****7ecbee4c6d9b8474498e****
InputConfig	string	The input configurations.	{ "MediaGroupArray": [{ "MediaArray": [ "**9d46c886b45481030f6e", "6c886b4549d481030f6e" ] }, { "MediaArray": [ "d46c886810b454930f6e", "4549d886810b46c30f6e**" ] }], "TitleArray": [ "Huilongguan Hema Fresh has opened"], "SpeechTextArray": [ "A new Hema Fresh store has opened in the nearby shopping mall,Today is the first day of opening"] }
EditingConfig	string	The editing configurations. For more information, see EditingConfig.	{ "MediaConfig": { "Volume": 0 }, "SpeechConfig": { "Volume": 1 }, "BackgroundMusicConfig": { "Volume": 0.3 } }
OutputConfig	string	The output configurations. For more information, 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 state. Valid values: Finished Init Failed Processing Valid values: Finished : Init : Failed : Processing :	Finished
UserData	string	The user-defined data in the JSON format, which can be up to 512 bytes in length. You can specify a custom callback URL. For more information, see Configure a callback upon editing completion.	{"NotifyAddress":"http://xx.xx.xxx"} or {"NotifyAddress":"https://xx.xx.xxx"} or {"NotifyAddress":"ice-callback-demo"}
Extend	string	The extended information of the job.	{}
CreateTime	string	The time when the job was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2023-06-09T06:36:48Z
ModifiedTime	string	The time when the job was last modified.	2023-06-09T06:37:58Z
CompleteTime	string	The time when the job was complete. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2023-06-09T06:38:09Z
JobType	string	The job type. Valid values: Script: script-based editing job that mixes media assets. Smart_Mix: intelligent editing job that mixes media assets. Valid values: Script : Smart_Mix :	Script
NextToken	string	A pagination token. It can be used in the next request to retrieve a new page of results.	8EqYpQbZ6Eh7+Zz8DxVYoQ==
MaxResults	integer	The number of entries per page. Valid values: 1 to 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      \"Huilongguan Hema Fresh has opened\"],\n  \"SpeechTextArray\": [\n      \"A new Hema Fresh store has opened in the nearby shopping mall,Today is the first day of opening\"]\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\"} or {\"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.