Creates a batch processing task to perform a data processing operation, such as transcoding or format conversion, on multiple existing files at a time.
Operation description
If you want to create a batch processing task to process data in OSS , make sure that you have bound the dataset to the OSS bucket where the data is stored. For more information about how to bind a dataset to a bucket, see AttachOSSBucket .
Debugging
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 Resourcesis 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 |
|---|---|---|---|---|
| imm:CreateBatch | create | *Batch acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/batch/* |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| ProjectName | string | Yes | test-project | |
| Input | Input | Yes | The data source configurations. | |
| Actions | array<object> | Yes | The processing templates. | |
| object | Yes | The processing template. | ||
| Name | string | Yes | The name of the template. | doc/convert |
| Parameters | array | No | The template parameters. | |
| string | No | The template parameter. | pages=3 | |
| FastFailPolicy | FastFailPolicy | No | The policy configurations for handling failures. | |
| Notification | object | No | The notification settings. The operation supports multiple messaging middleware options. For more information about notification messages, see Asynchronous message examples. You can use one of the following methods to receive notification messages: Activate and connect to EventBridge in the same region as the IMM project. For more information, see IMM events. Activate Simple Message Queue in the same region as the IMM project and configure a subscription. | |
| MNS | MNS | No | The Simple Message Queue notification message configurations. | |
| Tags | object | No | The custom tags. You can search for or filter asynchronous tasks by custom tag. | {"key": "val"} |
| ServiceRole | string | Yes | The service role. IMM assumes the service role so that it can access resources in other cloud services, such as OSS. Default value: AliyunIMMBatchTriggerRole. You can also create a custom service role in the RAM console and grant the required permissions to the role based on your business requirements. For more information, see Create a regular service role and Grant permissions to a role. | AliyunIMMDefaultRole |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "EC564A9A-BA5C-4499-A087-D9B9E76E*****",
"Id": "batch-4eb9223f-3e88-42d3-a578-3f2852******"
}Error codes
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2023-07-05 | The internal configuration of the API is changed, but the call is not affected | View Change Details |