Creates a Data Integration synchronization task.
Operation description
The CreateDISyncTask operation cannot specify scheduling properties. To configure scheduling properties, use the UpdataFile operation.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
dataworks:* |
get |
*All Resource
|
None | None |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| ProjectId |
integer |
Yes |
The ID of the DataWorks workspace. You can log on to the DataWorks console and go to the workspace configuration page to obtain the workspace ID. |
10000 |
| TaskType |
string |
Yes |
The task type of the Data Integration synchronization task to create. The CreateDISyncTask operation supports creating offline synchronization tasks (DI_OFFLINE), real-time synchronization tasks (DI_REALTIME), and solutions (DI_SOLUTION). |
DI_OFFLINE |
| TaskContent |
string |
Yes |
The script content of the Data Integration synchronization task. |
{"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_first","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 |
No |
The configuration parameters of the Data Integration synchronization task. The following parameters are supported:
When you create an offline synchronization task (TaskType=DI_OFFLINE), this parameter is required and must contain at least FileFolderPath. |
{"FileFolderPath":"Workflow/XXX/Data Integration","ResourceGroup":"Serverless_res_group_XXX_XXXX", "Cu":1.5} |
| TaskName |
string |
No |
The name of the Data Integration synchronization task to create. |
new_di_task |
| ClientToken |
string |
No |
The idempotency token. This parameter can be left empty. |
0000-ABCD-EFG**** |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
|||
| Success |
boolean |
Indicates whether the request is successful. |
true |
| RequestId |
string |
The request ID. You can use the ID to locate logs and troubleshoot issues. |
0bc1411515937635973**** |
| Data |
object |
The result of creating the Data Integration synchronization task. |
|
| Status |
string |
The status of the result of creating the Data Integration synchronization task. Valid values:
|
success |
| Message |
string |
The description of the cause of the failure to create the Data Integration synchronization task. If the task is created, this field is empty. If the task fails to be created, an example value is "Invalid directory path: Workflow/xxxx/Data Integration". |
Invalid directory path: Workflow/xxxx/Data Integration |
| FileId |
integer |
The ID of the successfully created Data Integration synchronization task. |
1000001 |
Examples
Success response
JSON format
{
"Success": true,
"RequestId": "0bc1411515937635973****",
"Data": {
"Status": "success",
"Message": "Invalid directory path: Workflow/xxxx/Data Integration",
"FileId": 1000001
}
}
Error codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 400 | Invalid.DI.Parameter | The parameter is invalid. | The parameter is invalid. |
| 400 | Invalid.DI.Parameter.File.Existed | The file name already exists. | The parameter is invalid. The file name already exists. |
| 500 | InternalError.DI.Parameter | A DI internal error occurred. | A Data Integration internal business error occurred. |
| 403 | Forbidden.DI.NoPrivilege | No access. | Access denied. |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.