Retrieve DI Sync Task Status via GetDISyncTask - DataWorks - Alibaba Cloud - DataWorks

Retrieves the details of a 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 ID of the DataWorks workspace. You can log on to the DataWorks console and go to the Workspace page to obtain the workspace 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	integer	Yes	If you set TaskType to DI_REALTIME, set this parameter to the ID of the real-time synchronization task that you want to deploy. If you set TaskType to DI_SOLUTION, set this 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 task or data synchronization solution.	100

Response elements

Element	Type	Description	Example
	object	The response parameters.
Success	boolean	Indicates whether the request was successful. Valid values: True False	true
RequestId	string	The request ID. You can locate logs and troubleshoot issues based on the ID.	0bc1411515937635973****
Data	object	The returned results.
Code	string	If the TaskType parameter is set to DI_REALTIME, the details of the real-time synchronization task are returned. If the TaskType parameter is set to DI_SOLUTION, the value null is returned.	{"extend":{"mode":"wizard","resourceGroup":"S_res_group_287114642182658_1560324290517"},"nodeDef":{},"order":{"hops":[{"from":"datahub_8htXSsfiS2vtZCVG","to":"datahub_CRHBAyGfhSaLmv2f"}]},"setting":{"errorLimit":{},"jvmOption":""},"steps":[{"stepType":"datahub","category":"writer","displayName":"DataHub1","parameter":{"batchSize":1000,"datasource":"datahub_cloud_dev_test","topic":"dwd_tfc_opt_speed_rid_amap_rt"},"name":"datahub_CRHBAyGfhSaLmv2f","gui":{"x":262,"y":325}},{"stepType":"datahub","displayName":"DataHub2","parameter":{"datasource":"datahub_uric_test","topic":"dwd_tfc_opt_speed_rid_amap_rt_330000","batchSize":1000},"name":"datahub_8htXSsfiS2vtZCVG","gui":{"x":268,"y":160.5},"category":"writer"}]}
Status	string	Indicates whether the details of the real-time synchronization task or data synchronization solution are obtained. Valid values: success: The details are obtained. fail: The details fail to be obtained.	success
Message	string	The cause of the failure to obtain the details of the real-time synchronization task or data synchronization solution. If the details of the real-time synchronization task or data synchronization solution are obtained, the value null is returned.	fileId:[100] is invalid.
AlarmList	array<object>	The alert rules that are associated with the real-time synchronization task. The value of this parameter is an array.
	array<object>	The alert rule that is associated with the real-time synchronization task.
Id	integer	The ID of the alert rule.	45242
Enabled	boolean	Indicates whether the alert rule is enabled.	true
RuleName	string	The name of the alert rule.	Delay alert rule name 1
Metric	string	The alert type. Valid values: taskStatus bizDelay taskFailoverCount ddlUnsupport ddlReport totalDirtyRecordWriteInLines	taskStatus
Description	string	The description of the alert rule.	Description
AlarmRuleList	array<object>	The alert notification settings. The value of this parameter is an array.
	object	The alert notification setting.
Level	string	WARNING CRITICAL	WARNING
Comparator	string	The comparison operator, which indicates the method used to compare a metric with the alert rule. '=' '<' '>'	=
Threshold	integer	The threshold for the comparison between a metric and the alert rule.	1
Duration	integer	The duration that a condition is met before an alert is triggered. Unit: minutes.	3
Aggregator	string	The calculation method of a metric. Valid values: avg max	avg
NotifyRule	object	The settings for alert notification rules. The value of this parameter is an array.
Interval	integer	The alert interval. Unit: minutes.	5
Warning	array	The settings for Warning-level alert notifications.
	string	The alert notification method. Valid values: Mail Phone Sms Ding	Ding
Critical	array	The settings for Critical-level alert notifications.
	string	The alert notification method. Valid values: Mail Phone Sms Ding	Ding
SolutionDetail	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 details of the data synchronization solution are returned.
Status	string	The status of the data synchronization solution. Valid values: 0: successful 1: not running 2: running 3: failed 4: committed 5: pending manual confirmation 6: manually confirmed 7: others 8: waiting 9: deleted	0
Type	string	The type of the data synchronization solution.	holo
StartTime	string	The start time of the data synchronization solution.	2021-12-07 14:40:51
CreatorName	string	The creator of the data synchronization solution.	dataworks_di
ProjectId	integer	The ID of the project to which the data synchronization solution belongs.	10000
SourceType	string	The type of the source of the data synchronization solution.	mysql
ProcessContent	string	The configuration details of the data synchronization solution.	{"holoDatasource":"holo","offlineSyncConfig":{"nodeNameRule":"oneclick_holo_di_${db_table_name_src}_to_${db_table_name_dest}","resourceGroup":"group_219193793999490"},"processRuleId":1007,"readerConcurrent":10,"realtimeSyncConfig":{"content":{"order":{"hops":[{"from":"reader","to":"writer"}]},"setting":{"speed":{"readerConcurrent":10}},"steps":[{"stepType":"mysql","name":"reader","category":"reader","parameter":{"connection":[{"datasource":"mm","datasourceType":"mysql","table":[]}]}},{"stepType":"holo","name":"writer","category":"writer","parameter":{"datasource":"holo","writeMode":"replay","datasourceSchema":"public","tableMappingRule":{"datasource":[{"tableRule":[],"srcDatasourceName":"mm"}]}}}]},"extend":{"mode":"migration_holo","resourceGroup":"group_219193793999490"}},"setting":{"autoCreateWorkflow":true,"userDefinedFileNameExpression":"oneclick"},"srcType":"mysql","tableMappingRuleFromRealtimeSyncConfig":{"datasource":[{"srcDatasourceName":"mm","tableRule":[]}]}}
Name	string	The name of the data synchronization solution.	holo_20211206161025
ProcessExtra	string	The additional parameters of the data synchronization solution.	{"processType":"new","tableNum":300}
SubmitTime	string	The time when the data synchronization solution was committed.	2021-12-07 14:40:51
Id	integer	The ID of the data synchronization solution.	100

Examples

Success response

JSON format

{
  "Success": true,
  "RequestId": "0bc1411515937635973****\t",
  "Data": {
    "Code": "{\"extend\":{\"mode\":\"wizard\",\"resourceGroup\":\"S_res_group_287114642182658_1560324290517\"},\"nodeDef\":{},\"order\":{\"hops\":[{\"from\":\"datahub_8htXSsfiS2vtZCVG\",\"to\":\"datahub_CRHBAyGfhSaLmv2f\"}]},\"setting\":{\"errorLimit\":{},\"jvmOption\":\"\"},\"steps\":[{\"stepType\":\"datahub\",\"category\":\"writer\",\"displayName\":\"DataHub1\",\"parameter\":{\"batchSize\":1000,\"datasource\":\"datahub_cloud_dev_test\",\"topic\":\"dwd_tfc_opt_speed_rid_amap_rt\"},\"name\":\"datahub_CRHBAyGfhSaLmv2f\",\"gui\":{\"x\":262,\"y\":325}},{\"stepType\":\"datahub\",\"displayName\":\"DataHub2\",\"parameter\":{\"datasource\":\"datahub_uric_test\",\"topic\":\"dwd_tfc_opt_speed_rid_amap_rt_330000\",\"batchSize\":1000},\"name\":\"datahub_8htXSsfiS2vtZCVG\",\"gui\":{\"x\":268,\"y\":160.5},\"category\":\"writer\"}]}",
    "Status": "success",
    "Message": "fileId:[100] is invalid.",
    "AlarmList": [
      {
        "Id": 45242,
        "Enabled": true,
        "RuleName": "Delay alert rule name 1",
        "Metric": "taskStatus",
        "Description": "Description",
        "AlarmRuleList": [
          {
            "Level": "WARNING",
            "Comparator": "=",
            "Threshold": 1,
            "Duration": 3,
            "Aggregator": "avg"
          }
        ],
        "NotifyRule": {
          "Interval": 5,
          "Warning": [
            "Ding"
          ],
          "Critical": [
            "Ding"
          ]
        }
      }
    ],
    "SolutionDetail": {
      "Status": "0",
      "Type": "holo",
      "StartTime": "2021-12-07 14:40:51",
      "CreatorName": "dataworks_di",
      "ProjectId": 10000,
      "SourceType": "mysql",
      "ProcessContent": "{\"holoDatasource\":\"holo\",\"offlineSyncConfig\":{\"nodeNameRule\":\"oneclick_holo_di_${db_table_name_src}_to_${db_table_name_dest}\",\"resourceGroup\":\"group_219193793999490\"},\"processRuleId\":1007,\"readerConcurrent\":10,\"realtimeSyncConfig\":{\"content\":{\"order\":{\"hops\":[{\"from\":\"reader\",\"to\":\"writer\"}]},\"setting\":{\"speed\":{\"readerConcurrent\":10}},\"steps\":[{\"stepType\":\"mysql\",\"name\":\"reader\",\"category\":\"reader\",\"parameter\":{\"connection\":[{\"datasource\":\"mm\",\"datasourceType\":\"mysql\",\"table\":[]}]}},{\"stepType\":\"holo\",\"name\":\"writer\",\"category\":\"writer\",\"parameter\":{\"datasource\":\"holo\",\"writeMode\":\"replay\",\"datasourceSchema\":\"public\",\"tableMappingRule\":{\"datasource\":[{\"tableRule\":[],\"srcDatasourceName\":\"mm\"}]}}}]},\"extend\":{\"mode\":\"migration_holo\",\"resourceGroup\":\"group_219193793999490\"}},\"setting\":{\"autoCreateWorkflow\":true,\"userDefinedFileNameExpression\":\"oneclick\"},\"srcType\":\"mysql\",\"tableMappingRuleFromRealtimeSyncConfig\":{\"datasource\":[{\"srcDatasourceName\":\"mm\",\"tableRule\":[]}]}}",
      "Name": "holo_20211206161025",
      "ProcessExtra": "{\"processType\":\"new\",\"tableNum\":300}",
      "SubmitTime": "2021-12-07 14:40:51",
      "Id": 100
    }
  }
}

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.