All Products
Search
Document Center

DataWorks:DeployDISyncTask

Last Updated:Oct 17, 2024

Deploys 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 type of the object that you want to deploy. Valid values:

  • DI_REALTIME: real-time synchronization node
  • DI_SOLUTION: data synchronization solution
10000
TaskTypestringYes
  • 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 deploy.
  • 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 deploy.

You can call the ListFiles operation to query the ID of the real-time synchronization node or data synchronization solution.

DI_REALTIME
FileIdlongYes

Indicates whether the request is successful. Valid values:

  • true: The request is successful.
  • false: The request fails.
100

Response parameters

ParameterTypeDescriptionExample
object
Successboolean

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

true
RequestIdstring

The result of deploying the real-time synchronization node or data synchronization solution.

0bc1411515937635973****
Dataobject

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.
Statusstring

The cause of the failure to deploy the real-time synchronization node or data synchronization solution.

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

success

Examples

Sample success responses

JSONformat

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

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.