ListBatchMediaProducingJobs - Intelligent Media Services

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

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:ListBatchMediaProducingJobs	list	All Resources ``	none	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.	Script
Status	string	No	The job state. 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.	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 parameters

Parameter	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.
EditingBatchJob	object	The queried quick video production job.
JobId	string	The ID of the quick video production job.	****7ecbee4c6d9b8474498e****
InputConfig	string	The input configurations.
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	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.
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.	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

Sample success responses

JSONformat

{
  "RequestId": "******3B-0E1A-586A-AC29-742247******",
  "EditingBatchJobList": [
    {
      "JobId": "******7ecbee4c6d9b8474498e******",
      "InputConfig": "",
      "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": "",
      "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

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