BatchUpdateTasks - DataWorks - Alibaba Cloud Documentation Center

Performs incremental updates on multiple tasks at a time.

Operation description

This API operation is available for all DataWorks editions.

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

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
Tasks	array<object>	No	The tasks.
Task	object	No
Id	long	Yes	The task ID.	1234
EnvType	string	No	The environment of the workspace. Valid values: Prod: production environment Dev: development environment	Prod
Name	string	No	The name of the task.	SQL node
Description	string	No	The description of the task.	test
Owner	string	No	The account ID of the task owner.	1000
Timeout	integer	No	The timeout period of task running. Unit: seconds.	3600
RerunMode	string	No	The rerun mode. Valid values: AllDenied: The task cannot be rerun regardless of whether the task is successfully run or fails to run. FailureAllowed: The task can be rerun only after it fails to run. AllAllowed: The task can be rerun regardless of whether the task is successfully run or fails to run.	AllAllowed
RerunTimes	integer	No	The number of times that the task is rerun. This parameter takes effect only if the RerunMode parameter is set to AllAllowed or FailureAllowed.	3
RerunInterval	integer	No	The rerun interval. Unit: seconds.	60
Trigger	object	No	The trigger method.
Type	string	No	The trigger type. Valid values: Scheduler: periodic scheduling Manual: manual scheduling	Scheduler
Recurrence	string	No	The running mode of the task after it is triggered. This parameter takes effect only if the Type parameter is set to Scheduler. Valid values: Pause Skip Normal	Normal
Cron	string	No	The CRON expression of the task. This parameter takes effect only if the Type parameter is set to Scheduler.	00 00 00 * * ?
StartTime	string	No	The start time of the time range during which the task is periodically scheduled. This parameter takes effect only if the Type parameter is set to Scheduler.	1970-01-01 00:00:00
EndTime	string	No	The end time of the time range during which the task is periodically scheduled. This parameter takes effect only if the Type parameter is set to Scheduler.	9999-01-01 00:00:00
RuntimeResource	object	No	The configurations of the runtime environment, such as the resource group information.
ResourceGroupId	string	No	The ID of the resource group for scheduling configured for task running.	S_res_group_524258031846018_1684XXXXXXXXX
Image	string	No	The ID of the image configured for task running.	i-xxxxxx
Cu	string	No	The default number of compute units (CUs) configured for task running.	0.25
DataSource	object	No	The information about the associated data source.
Name	string	No	The name of the data source.	odps_test
Tags	array<object>	No	The tags.
Tag	object	No
Key	string	Yes	The tag key.	key1
Value	string	No	The tag value.	value1
Comment	string	No	The remarks.	this is a comment

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	22C97E95-F023-56B5-8852-B1A77A17XXXX
SuccessInfo	object	The result of the batch operation, which is in the MAP structure. The task ID serves as a key, and the result serves as a value.
	object	The result.
Success	boolean	Indicates whether the request was successful.	true
Message	string	The error message.	The task does not exist.

Examples

Sample success responses

JSONformat

{
  "RequestId": "22C97E95-F023-56B5-8852-B1A77A17XXXX",
  "SuccessInfo": {
    "key": {
      "Success": true,
      "Message": "The task does not exist."
    }
  }
}

Error codes

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