GetDISyncInstanceInfo - DataWorks - Alibaba Cloud Documentation Center

Queries the status of a real-time synchronization task or a data synchronization solution.

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.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
dataworks:*	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
ProjectId	long	Yes	The DataWorks workspace ID. You can log on to the DataWorks console and go to the Workspace page to query the ID. You must configure this parameter to specify the DataWorks workspace to which the API operation is applied.	10000
TaskType	string	Yes	The type of the object that you want to query. Valid values: DI_REALTIME: real-time synchronization task DI_SOLUTION: data synchronization solution	DI_REALTIME
FileId	long	Yes	If you set the TaskType parameter to DI_REALTIME, set the FileId parameter to the ID of the real-time synchronization task that you want to query. 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 query. You can call the ListFiles operation to query the ID of the real-time synchronization task or data synchronization solution.	100

Response parameters

Parameter	Type	Description	Example
	object	The returned data.
Success	boolean	Indicates whether the request was successful. Valid values: true false	true
RequestId	string	The request ID.	0bc1411515937635973****
Data	object	The status of the real-time synchronization task or data synchronization solution.
Status	string	If the TaskType parameter is set to DI_REALTIME, the Status parameter indicates the status of the real-time synchronization task. Valid values: PAUSE, NORUN, RUN, KILLING, and WAIT. If the TaskType parameter is set to DI_SOLUTION, the Status parameter indicates the status of the data synchronization solution. Valid values: success and fail.	RUN
Message	string	The cause of the failure to obtain the status of the real-time synchronization task or data synchronization solution. If the status of the real-time synchronization task or data synchronization solution is obtained, the value null is returned.	fileId[100] is invalid
Name	string	If the TaskType parameter is set to DI_REALTIME, the Name parameter indicates the name of the real-time synchronization task. If the TaskType parameter is set to DI_SOLUTION, the value null is returned.	streamx_name
SolutionInfo	object	If the TaskType parameter is set to DI_REALTIME, the value null is returned. If the TaskType parameter is set to DI_SOLUTION, the SolutionInfo parameter indicates the details of the data synchronization solution.
Status	string	The status of the data synchronization solution.	run
Id	long	The ID of the data synchronization solution.	100
CreatorName	string	The creator of the data synchronization solution.	dataworks_3h1
StepDetail	array<object>	The step details of the data synchronization solution.
StepDetail	object	The returned data.
Status	string	The status of the step in the data synchronization solution.	success
StepId	long	The ID of the step in the data synchronization solution.	1
StepName	string	The name of the step in the data synchronization solution.	Create a base table
Info	string	The information of the data synchronization solution.	{\"fusionProps\":{\"dataSource\":[{\"fileName\":\"holo_20221020161613\",\"status\":\"SUCCESS\"}]},\"customProps\":{\"showSN\":true,\"columns\":[{\"dataIndex\":\"fileName\",\"width\":0.8,\"title\":\"Real-time synchronization name\"},{\"dataIndex\":\"status\",\"width\":0.2,\"title\":\"Status\"}]},\"componentName\":\"Table\"}

Examples

Sample success responses

JSONformat

{
  "Success": true,
  "RequestId": "0bc1411515937635973****",
  "Data": {
    "Status": "RUN",
    "Message": "fileId[100] is invalid",
    "Name": "streamx_name",
    "SolutionInfo": {
      "Status": "run",
      "Id": 100,
      "CreatorName": "dataworks_3h1",
      "StepDetail": [
        {
          "Status": "success",
          "StepId": 1,
          "StepName": "Create a base table",
          "Info": "{\\\"fusionProps\\\":{\\\"dataSource\\\":[{\\\"fileName\\\":\\\"holo_20221020161613\\\",\\\"status\\\":\\\"SUCCESS\\\"}]},\\\"customProps\\\":{\\\"showSN\\\":true,\\\"columns\\\":[{\\\"dataIndex\\\":\\\"fileName\\\",\\\"width\\\":0.8,\\\"title\\\":\\\"Real-time synchronization name\\\"},{\\\"dataIndex\\\":\\\"status\\\",\\\"width\\\":0.2,\\\"title\\\":\\\"Status\\\"}]},\\\"componentName\\\":\\\"Table\\\"}"
        }
      ]
    }
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	Param.Invalid	The parameter is invalid.	Param invalid
403	Forbidden.Access	Access is forbidden.	-
500	InternalError.System	An internal error occurred.	InternalError

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