DeployDISyncTask

Updated at:

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 ID of the DataWorks workspace. You can log on to the DataWorks console and go to the workspace configuration page to obtain the workspace ID. The request operates on this workspace.

10000

TaskType

string

Yes

The type of the object that you want to deploy. Valid values:

  • DI_REALTIME: real-time synchronization task

  • DI_SOLUTION: synchronization task created in Data Integration

DI_REALTIME

FileId

integer

Yes

  • If you set the TaskType parameter to DI_REALTIME, set the FileId parameter to the file ID of the real-time synchronization task that you want to deploy.

  • If you set the TaskType parameter to DI_SOLUTION, set the FileId parameter to the ID of the synchronization task that you want to deploy.

You can call the ListFiles operation to query the file ID of the real-time synchronization task or the synchronization task created in Data Integration.

100

Response elements

Element

Type

Description

Example

object

The response parameters.

Success

boolean

Indicates whether the request is successful. Valid values: true (successful) and false (failed).

true

RequestId

string

The request ID. You can use the ID to query logs and troubleshoot issues.

0bc14115159376359******

Data

object

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

  • success: The real-time synchronization node or data synchronization solution is deployed.

  • fail: The real-time synchronization node or data synchronization solution fails to be deployed.

Status

string

The result status. A value of success indicates that the operation succeeded, and fail indicates that it failed.

success

Message

string

Deploy a Data Integration synchronization task

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.