Trigger Real-Time Sync via StartDISyncInstance API - DataWorks - Alibaba Cloud - DataWorks

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

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dataworks:*

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ProjectId	integer	Yes	The DataWorks workspace ID. You can obtain the ID on the Workspace page in the DataWorks console.	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	integer	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, this parameter specifies startup parameters for the real-time synchronization task, including failover settings, the dirty data record limit, and DDL handling rules. If you set TaskType to DI_SOLUTION, this 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 elements

Element	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, which you can use to locate logs and troubleshoot issues.	0bc1411515937635973****
Data	object	The result of the start operation.
Status	string	Indicates whether the task or solution was started. Valid values: success: The task or solution was started. fail: The task or solution failed to start. You can troubleshoot based on the provided cause.	success
Message	string	The failure cause. This parameter is returned only when the start operation fails. If the task or solution is started, null is returned.	fileId:[100] is invalid.

Examples

Success response

JSON format

{
  "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
500	InternalError.System	An internal error occurred.	InternalError
403	Forbidden.Access	Access is forbidden.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.