CreateDISyncTask - DataWorks - Alibaba Cloud Documentation Center

Creates a data synchronization task.

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
ProjectId	long	Yes	The DataWorks workspace ID. You can log on to the DataWorks console and go to the Workspace page to query the ID.	10000
TaskType	string	Yes	The type of the data synchronization task. Valid values: DI_OFFLINE, DI_REALTIME, and DI_SOLUTION.	DI_OFFLINE
TaskContent	string	Yes	The configurations of the batch synchronization task to be created. Calling this API operation to create a batch synchronization task is equivalent to creating a batch synchronization task by using the code editor in the DataWorks console. For more information, see Create a data synchronization task by using the code editor.	{"type":"job","version":"2.0","steps":[{"stepType":"mysql","parameter":{"envType":1,"datasource":"mysql_pub","column":["id","name","create_time","age","score","t_01"],"connection":[{"datasource":"mysql_pub","table":["u_pk"]}],"where":"","splitPk":"id","encoding":"UTF-8"},"name":"Reader","category":"reader"},{"stepType":"odps","parameter":{"partition":"pt=${bizdate}","truncate":true,"datasource":"odps_source","envType":1,"column":["id","name","create_time","age","score","t_01"],"emptyAsNull":false,"tableComment":"null","table":"u_pk"},"name":"Writer","category":"writer"}],"setting":{"executeMode":null,"errorLimit":{"record":""},"speed":{"concurrent":2,"throttle":false}},"order":{"hops":[{"from":"Reader","to":"Writer"}]}}
TaskParam	string	Yes	The settings that specify the storage path of the data synchronization task and the resource group used by the task. The following parameters are supported: FileFolderPath: the storage path of the data synchronization task. ResourceGroup: the identifier of the resource group for Data Integration that is used by the data synchronization task. You can call the ListResourceGroups operation to query the identifier of the resource group.	{"FileFolderPath":"Business Flow/XXX/Data Integration","ResourceGroup":"S_res_group_XXX_XXXX"}
TaskName	string	Yes	The name of the data synchronization task.	new_di_task
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. This parameter can be left empty.	0000-ABCD-EFG****

Response parameters

Parameter	Type	Description	Example
	object
Success	boolean	Indicates whether the request was successful.	true
RequestId	string	The request ID.	0bc1411515937635973****
Data	object	The information that indicates whether the data synchronization task is created.
Status	string	The creation status of the data synchronization task. Valid values: success fail	success
Message	string	The error message that is returned if the data synchronization task fails to be created. If the data synchronization task is successfully created, this parameter is not returned. If the data synchronization task fails to be created, an error message in the "Invalid path: Workflow/xxxx/Data Integration" format is returned.	Invalid path: Business Flow/xxxx/Data Integration
FileId	long	The ID of the data synchronization task that is created.	1000001

Examples

Sample success responses

JSONformat

{
  "Success": true,
  "RequestId": "0bc1411515937635973****",
  "Data": {
    "Status": "success",
    "Message": "Invalid path: Business Flow/xxxx/Data Integration",
    "FileId": 1000001
  }
}

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.
403	Forbidden.DI.NoPrivilege	No access.
500	InternalError.DI.Parameter	A DI internal error occurred.

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

Change history

Change time	Summary of changes	Operation
2024-09-23	The Error code has changed	View Change Details