Generate configuration to asynchronously update a real-time synchronization task - DataWorks - Alibaba Cloud - DataWorks

Operation description

DataWorks allows you to directly call the UpdateDISyncTask operation to update batch synchronization tasks in Data Integration. To update a real-time synchronization task, you must first call the GenerateDISyncTaskConfigForUpdating and QueryDISyncTaskConfigProcessResult operations to asynchronously generate the required parameters, and then pass the parameters to the UpdateDISyncTask operation. Only asynchronous updates are supported for real-time synchronization tasks in Data Integration.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
ProjectId	integer	Yes	The DataWorks workspace ID. You can log on to the DataWorks console and go to the Workspace page to obtain the workspace ID. You must configure this parameter to specify the DataWorks workspace to which the API operation is applied.	10000
TaskType	string	Yes	The type of the object that you want to update in Data Integration in asynchronous mode. Valid values: DI_REALTIME: real-time synchronization task DI_SOLUTION: synchronization solution DataWorks allows you to create or update real-time synchronization tasks in Data Integration only in asynchronous mode. Valid values: DI_OFFLINE DI_REALTIME DI_SOLUTION	DI_REALTIME
TaskParam	string	Yes	The script for updating the real-time synchronization task in Data Integration. DataWorks allows you to add or remove tables for a real-time synchronization task in Data Integration only in asynchronous mode. The following types of real-time synchronization tasks are supported: Synchronization task that is used to synchronize data from MySQL to MaxCompute Synchronization task that is used to synchronize data from MySQL data to Kafka Synchronization task that is used to synchronize data from MySQL to Hologres The SelectedTables parameter is used to specify tables that you want to synchronize from multiple databases. The Tables parameter is used to specify tables that you want to synchronize from a single database. If the script contains the SelectedTables parameter, the system synchronizes data from the tables that you specify in the SelectedTables parameter. If the script contains the Tables parameter, the system synchronizes data from the tables that you specify in the Tables parameter.	{"steps":[{"parameter":{"connection":[{"table":["xyx"]}]},"name":"Reader","category":"reader"}]}
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. This parameter is used to prevent repeated operations that are caused by multiple calls.	ABFUOEUOTRTRJKE
TaskId	integer	Yes	The task ID. If you set the TaskType parameter to DI_REALTIME, set the TaskId parameter to the value of the FileId parameter for the real-time synchronization task. If you set the TaskType parameter to DI_SOLUTION, set the TaskId parameter to the value of the FileId parameter for the synchronization solution.	100

Response elements

Element	Type	Description	Example
	object	The returned results.
Success	boolean	Indicates whether the request was successful. Valid values: true false	true
RequestId	string	The request ID. You can locate logs and troubleshoot issues based on the ID.	0bc1411515937635973****
Data	object	The information returned for the ID of the asynchronous thread.
Status	string	Indicates whether the ID of the asynchronous thread is generated. Valid values: success: indicates that the ID of the asynchronous thread is generated. fail: indicates that the ID of the asynchronous thread fails to be generated. You can view the reason for the failure and troubleshoot the issue based on the reason.	true
ProcessId	integer	The ID of the asynchronous thread. You can call the QueryDISyncTaskConfigProcessResult operation to obtain the asynchronously generated parameters based on the ID. The parameters are used to update a real-time synchronization task in Data Integration.	10
Message	string	The reason why the ID of the asynchronous thread fails to be generated. If the ID is successfully generated, no value is returned for this parameter.	XXX is invalid.

Examples

Success response

JSON format

{
  "Success": true,
  "RequestId": "0bc1411515937635973****",
  "Data": {
    "Status": "true",
    "ProcessId": 10,
    "Message": "XXX is invalid."
  }
}

Error codes

HTTP status code	Error code	Error message
400	Invalid.DI.Parameter	The parameter is invalid.
400	Invalid.DI.Parameter.File.Existed	The file name already exists.
500	InternalError.DI.Parameter	A DI internal error occurred.
403	Forbidden.DI.NoPrivilege	No access.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.