DeployDISyncTask -

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	DeployDISyncTask	The operation that you want to perform. Set the value to DeployDISyncTask.
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 query the workspace ID. This parameter specifies the DataWorks workspace to which the operation is applied.
TaskType	String	Yes	DI_REALTIME	The type of the object that you want to deploy. 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 that of the China (Zhangjiakou) region is cn-zhangjiakou. The system 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 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.

Response parameters


Parameter	Type	Example	Description
Success	Boolean	true	Indicates whether the request is successful. Valid values: true: The request is successful. false: The request fails.
RequestId	String	0bc1411515937635973****	The ID of the request. You can query logs and troubleshoot issues based on the ID.
Data	Object		The result of deploying the real-time synchronization node or data synchronization solution.
Status	String	success	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.
Message	String	submit and deploy fail.	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.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DeployDISyncTask
&ProjectId=10000
&TaskType=DI_REALTIME
&FileId=100
&<Common request parameters>

Sample success responses

XML format

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

<DeployDISyncTaskResponse>
    <Success>true</Success>
    <RequestId>0bc1411515937635973****</RequestId>
    <Data>
        <Status>success</Status>
        <Message>submit and deploy fail.</Message>
    </Data>
</DeployDISyncTaskResponse>

JSON format

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

{
  "Success" : true,
  "RequestId" : "0bc1411515937635973****",
  "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.	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.