All Products
Search
Document Center

DataWorks:TerminateDISyncInstance

Last Updated:Nov 21, 2024

Undeploys a real-time 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.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
ProjectIdlongYes

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
TaskTypestringYes

The value DI_REALTIME indicates that the task is a real-time synchronization task.

DI_REALTIME
FileIdlongYes

The ID of the real-time synchronization task.

100

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

Successboolean

Indicates whether the request was successful. Valid values:

  • true
  • false
true
RequestIdstring

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

0bc1411515937635973****
Dataobject

The returned results.

Statusstring

Indicates whether the real-time synchronization task is undeployed. Valid values:

  • success
  • fail
success
Messagestring

The reason why the real-time synchronization task fails to be terminated. If the real-time synchronization task is undeployed, the value of this parameter is null.

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 codeError codeError messageDescription
400Param.InvalidThe parameter is invalid.Param invalid
403Forbidden.AccessAccess is forbidden.-
500InternalError.SystemAn internal error occurred.InternalError

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