CreateBatch - Intelligent Media Management - Alibaba Cloud Documentation Center

Creates a batch processing task that performs specified operations, such as transcoding and format conversion, on multiple existing files.

Operation description

If you want to process data using Object Storage Service (OSS) data processing, make sure you bind an OSS bucket before you create a batch processing task.

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

imm:CreateBatch

create

*Batch

acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/batch/*

None

Request parameters

Parameter	Type	Required	Description	Example
ProjectName	string	Yes	The project name. For more information, see Create a project.	test-project
Input	Input	Yes	The input data source configuration.
Actions	array<object>	Yes	A list of processing templates.
	object	No	A processing template.
Name	string	Yes	The template name.	doc/convert
Parameters	array	No	A list of template parameters.
	string	No	A template parameter.	pages=3
FastFailPolicy	FastFailPolicy	No	The fast-fail policy configuration.
Notification	object	No	The notification recipient. Multiple middleware services are supported. For details about the message format, see Asynchronous notification message. Select one of the following methods to receive messages: Activate and access EventBridge in the same region as Intelligent Media Management (IMM) to promptly receive task notifications. For more information, see IMM events. Activate MNS in the same region as IMM and configure a subscription.
MNS	MNS	No	The parameters for MNS notifications.
Tags	object	No	Custom tags used to search and filter asynchronous tasks.	{"key": "val"}
ServiceRole	string	Yes	The service role that grants IMM the permissions to access other cloud resources, such as OSS. The default value is AliyunIMMBatchTriggerRole. To use a custom service role, create a service role and grant permissions to the role in the RAM console. For more information, see Create a service role and Grant permissions to a RAM role.	AliyunIMMBatchTriggerRole

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	EC564A9A-BA5C-4499-A087-D9B9E76E*****
Id	string	The batch processing task ID.	batch-4eb9223f-3e88-42d3-a578-3f2852******

Examples

Success response

JSON format

{
  "RequestId": "EC564A9A-BA5C-4499-A087-D9B9E76E*****",
  "Id": "batch-4eb9223f-3e88-42d3-a578-3f2852******"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.