StartDISyncInstance - DataWorks - Alibaba Cloud Documentation Center

Starts a real-time synchronization task or a synchronization solution.

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

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 Resources is 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
dataworks:*	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
ProjectId	long	Yes	The ID of the DataWorks workspace. 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 start. Valid values: DI_REALTIME: real-time synchronization task DI_SOLUTION: data synchronization solution	DI_REALTIME
FileId	long	Yes	If you set TaskType to DI_REALTIME, set this parameter to the ID of the real-time synchronization task that you want to start. If you set TaskType to DI_SOLUTION, set this parameter to the ID of the data synchronization solution that you want to start.	100
StartParam	string	No	If you set TaskType to DI_REALTIME, the StartParam parameter specifies the startup parameters for the real-time synchronization task. The startup parameters include failover-related parameters, the parameter that specifies the number of dirty data records allowed, and the parameters in the data definition language (DDL) statements. If you set TaskType to DI_SOLUTION, the StartParam parameter does not take effect.	{"failoverLimit":{"count":10,"interval":30},"errorLimit":{"record":0},"ddlMarkMap":{"RENAMECOLUMN":"WARNING","DROPTABLE":"WARNING","CREATETABLE":"IGNORE","MODIFYCOLUMN":"WARNING","TRUNCATETABLE":"NORMAL","DROPCOLUMN":"IGNORE","ADDCOLUMN":"NORMAL","RENAMETABLE":"CRITICAL"}}

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
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 result returned for the start.
Status	string	Indicates whether the real-time synchronization task or the data synchronization solution is started. Valid values: success: The real-time synchronization task or the data synchronization solution is started. fail: The real-time synchronization task or the data synchronization solution fails to be started. You can troubleshoot the issue based on the provided cause.	success
Message	string	The reason why the real-time synchronization task or the data synchronization solution fails to be started. If the real-time synchronization task or the data synchronization solution is started, the value null is returned.	fileId:[100] is invalid.

Examples

Sample success responses

JSONformat

{
  "Success": true,
  "RequestId": "0bc1411515937635973****",
  "Data": {
    "Status": "success",
    "Message": "fileId:[100] is invalid."
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	Param.Invalid	The parameter is invalid.	Param invalid
403	Forbidden.Access	Access is forbidden.	-
500	InternalError.System	An internal error occurred.	InternalError

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