Updates information about a batch processing task, including the input data source, data processing settings, and tags.
Operation description
- You can update only a batch processing task that is in the Ready or Failed state. The update operation does not change the status of the batch processing task.
- If you update a batch processing task that is in progress, the task is not automatically resumed after the update is complete. You must call the ResumeBatch operation to resume the task.
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:UpdateBatch | update | *All Resources * |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| ProjectName | string | Yes | The name of the project. You can obtain the name of the project from the response of the CreateProject operation. | test-project |
| Id | string | Yes | The ID of the batch processing task. You can obtain the ID of the batch processing task from the response of the CreateBatch operation. | batch-4eb9223f-3e88-42d3-a578-3f2852****** |
| Input | Input | No | The input data source. | |
| Actions | array<object> | No | The processing templates. | |
| object | No | The processing template. | ||
| Name | string | No | The name of the template. | doc/convert |
| Parameters | array | No | The template parameters. | |
| string | No | The template parameter. | pages=3 | |
| Tags | object | No | The custom tags. You can search for or filter asynchronous tasks by custom tag. | {"key":"val"} |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "CB4D73A3-BAF4-4A9D-A631-15F219AF****"
}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 request parameters of the API has changed | View Change Details |