获取数据集成实时同步任务和同步解决方案的详情。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 GetDISyncTask

系统规定参数。取值：GetDISyncTask。

ProjectId Long 是 10000

DataWorks工作空间的ID。您可以登录DataWorks控制台，进入工作空间管理页面获取ID。

该参数用来确定本次API调用操作使用的DataWorks工作空间。
TaskType String 是 DI_REALTIME

目标数据源所关联的数据集成同步任务的任务类型。取值如下：

  • DI_REALTIME：表示数据集成实时同步任务。
  • DI_SOLUTION：表示数据集成同步解决方案。
RegionId String 是 cn-zhangjiakou

地域信息，通常为服务所在的地域。例如，华东2（上海）为cn-shanghai，华北3（张家口）为cn-zhangjiakou。您无需填写RegionId，会根据调用的Endpoint自动解析。
FileId Long 是 100
  • 当TaskType为DI_REALTIME时，则FileId为实时同步任务的文件ID。
  • 当TaskType为DI_SOLUTION时，则FileId为同步解决方案的任务ID。

您可以调用ListFiles接口获取任务ID。

返回数据

名称 类型 示例值 描述
Success Boolean true

请求是否成功。取值如下：

  • True：成功。
  • False：失败。
RequestId String 0bc1411515937635973****

请求ID。用于定位日志，排查问题。
Data Object

获取数据集成任务的返回结果。
Code String {"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"}]}
  • 如果TaskType为DI_REALTIME，则获取实时同步任务的详情。
  • 如果TaskType为DI_SOLUTION，则为null。
Status String success

获取数据集成同步任务的结果状态。取值如下：

Success：表示获取数据集成同步任务成功。

Fail：表示获取数据集成同步任务失败。
Message String fileId:[100] is invalid.

获取数据集成同步任务失败后的原因描述。

如果获取数据集成同步任务成功，则该参数的返回值为空。
SolutionDetail Object
  • 如果TaskType为DI_REALTIME，则为null。
  • 如果TaskType为DI_SOLUTION，则获取同步解决方案任务的详情。
Status String 0

同步解决方案的执行状态

  • 0-成功
  • 1-未运行
  • 2-运行中
  • 3-失败
  • 4-提交
  • 5-待人工确认
  • 6-人工确认完成
  • 7-其他
  • 8-等待
  • 9-已删除
Type String holo

同步解决方案任务的类型。
StartTime String 2021-12-07 14:40:51

同步解决方案任务的开始时间。
CreatorName String dataworks_di

同步解决方案任务的创建者名称。
ProjectId Long 10000

同步解决方案任务所在的项目ID。
SourceType String mysql

同步解决方案任务源端的类型。
ProcessContent String {"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 holo_20211206161025

同步解决方案任务的名称。
ProcessExtra String {"processType":"new","tableNum":300}

同步解决方案任务的额外参数。
SubmitTime String 2021-12-07 14:40:51

同步解决方案任务提交的时间。
Id Long 100

同步解决方案的任务ID。

示例

请求示例

http(s)://[Endpoint]/?Action=GetDISyncTask
&ProjectId=10000
&TaskType=DI_REALTIME
&FileId=100
&公共请求参数

正常返回示例

XML格式 

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

<GetDISyncTaskResponse>
    <Success>true</Success>
    <RequestId>0bc1411515937635973****	</RequestId>
    <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"}]}</Code>
        <Status>success</Status>
        <Message>fileId:[100] is invalid.</Message>
        <SolutionDetail>
            <Status>0</Status>
            <Type>holo</Type>
            <StartTime>2021-12-07 14:40:51</StartTime>
            <CreatorName>dataworks_di</CreatorName>
            <ProjectId>10000</ProjectId>
            <SourceType>mysql</SourceType>
            <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":[]}]}}</ProcessContent>
            <Name>holo_20211206161025</Name>
            <ProcessExtra>{"processType":"new","tableNum":300}</ProcessExtra>
            <SubmitTime>2021-12-07 14:40:51</SubmitTime>
            <Id>100</Id>
        </SolutionDetail>
    </Data>
</GetDISyncTaskResponse>

JSON格式 

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

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

错误码

HttpCode 错误码 错误信息 描述
400 Param.Invalid The parameter is invalid. 参数错误
500 InternalError.System An internal error occurred. 内部报错
403 Forbidden.Access Access is forbidden. 没有权限

访问错误中心查看更多错误码。