Use GetDISyncInstanceInfo to query the status of synchronization tasks and solutions - DataWorks - Alibaba Cloud - DataWorks

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

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

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dataworks:*

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ProjectId	integer	Yes	The DataWorks workspace ID. You can log on to the DataWorks console and go to the Workspace page to obtain the ID.	10000
TaskType	string	Yes	The type of the synchronization object to query. Valid values: DI_REALTIME: real-time synchronization task DI_SOLUTION: data synchronization solution	DI_REALTIME
FileId	integer	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 elements

Element	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 error message returned if the status query fails. A value of null indicates success.	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	integer	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.
	object	The details of a step.
Status	string	The status of the step in the data synchronization solution.	success
StepId	integer	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 details of the step in the data synchronization solution, returned as a JSON string.	{\"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

Success response

JSON format

{
  "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
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.