Starts a real-time synchronization node or a data synchronization solution.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes StartDISyncInstance

The operation that you want to perform.

ProjectId Long Yes 10000

The ID of the DataWorks workspace. You can log on to the DataWorks console and go to the Workspace Management page to obtain the workspace ID.

You must set this parameter to specify the DataWorks workspace in which the real-time synchronization node or the data synchronization solution resides.

TaskType String Yes DI_REALTIME

The type of the Data Integration object that you want to start. Valid values:

  • DI_REALTIME: real-time synchronization node
  • DI_SOLUTION: data synchronization solution
RegionId String Yes cn-zhangjiakou

The region ID. For example, the ID of the China (Shanghai) region is cn-shanghai, and the ID of the China (Zhangjiakou) region is cn-zhangjiakou. The system automatically determines the value of this parameter based on the endpoint that is used to call the operation.

FileId Long Yes 100
  • If you set the TaskType parameter to DI_REALTIME, set the FileId parameter to the ID of the real-time synchronization node that you want to start.
  • If you set the TaskType parameter to DI_SOLUTION, set the FileId parameter to the ID of the data synchronization solution that you want to start.
StartParam String No null
  • If you set the TaskType parameter to DI_REALTIME, the StartParam parameter specifies the startup parameters for the real-time synchronization node. 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 the TaskType parameter to DI_SOLUTION, the StartParam parameter does not take effect.

Response parameters

Parameter Type Example Description
Success Boolean true

Indicates whether the request is successful. Valid values:

  • true: The request succeeded.
  • false: The request failed.
RequestId String 0bc1411515937635973****

The ID of the request. You can locate logs and troubleshoot issues based on the ID.

Data Object

The result returned for the start.

Status String success

Indicates whether the real-time synchronization node or the data synchronization solution is started. Valid values:

  • success: The real-time synchronization node or the data synchronization solution is started.
  • fail: The real-time synchronization node or the data synchronization solution fails to be started. You can troubleshoot the issue based on the provided cause.
Message String fileId:[100] is invalid.

The reason why the real-time synchronization node or the data synchronization solution fails to be started.

If the real-time synchronization node or the data synchronization solution is started, the value null is returned.

Examples

Sample requests

http(s)://[Endpoint]/?Action=StartDISyncInstance
&ProjectId=10000
&TaskType=DI_REALTIME
&FileId=100
&StartParam={"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"}}
&<Common request parameters>

Sample success responses

XML format 

HTTP/1.1 200 OK
Content-Type:application/xml

<StartDISyncInstanceResponse>
    <RequestId>0bc1411515937635973****</RequestId>
    <Data>
        <Status>success</Status>
        <Message>fileId:[100] is invalid.</Message>
    </Data>
    <Success>true</Success>
</StartDISyncInstanceResponse>

JSON format 

HTTP/1.1 200 OK
Content-Type:application/json

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

Error codes

HTTP status code Error code Error message Description
400 Param.Invalid The parameter is invalid. The error message returned because one or more parameters are invalid.
500 InternalError.System An internal error occurred. The error message returned because an internal error has occurred.
403 Forbidden.Access Access is forbidden. The error message returned because you are not authorized to perform this operation.

For a list of error codes, visit the API Error Center.