All Products
Search
Document Center

DataWorks:DeployDISyncTask

Last Updated:Aug 28, 2026

Deploys a real-time synchronization task.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter

Type

Required

Description

Example

ProjectId

integer

Yes

The type of object to deploy. Valid values:

  • DI_REALTIME: real-time synchronization node

  • DI_SOLUTION: data synchronization solution

10000

TaskType

string

Yes

The type of object to deploy. Valid values:

  • DI_REALTIME: real-time synchronization task

  • DI_SOLUTION: synchronization task created in Data Integration

DI_REALTIME

FileId

integer

Yes

  • If TaskType is set to DI_REALTIME, set this parameter to the ID of the real-time synchronization task to deploy.

  • If TaskType is set to DI_SOLUTION, set this parameter to the ID of the data synchronization solution to deploy.

You can call the ListFiles operation to query the ID of the task.

100

Response elements

Element

Type

Description

Example

object

The response body.

Success

boolean

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

true

RequestId

string

The request ID. Use it to query logs and troubleshoot issues.

0bc14115159376359******

Data

object

The deployment result. Valid values:

  • success: The task is deployed.

  • fail: The task failed to be deployed.

Status

string

The cause of the deployment failure.

If the deployment succeeds, null is returned.

success

Message

string

The error message returned if the deployment fails.

If the deployment succeeds, this parameter is empty.

submit and deploy fail.

Examples

Success response

JSON format

{
  "Success": true,
  "RequestId": "0bc14115159376359******",
  "Data": {
    "Status": "success",
    "Message": "submit and deploy fail."
  }
}

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.