调用ListRefDISyncTasks接口,查看目标数据源所关联的数据集成同步任务。

调试

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

请求参数

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

要执行的操作。

DatasourceName String mysql_datasource

需要查看的目标数据源名称。您可以调用ListDataSources接口获取数据源名称。

TaskType String DI_OFFLINE

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

  • DI_OFFLINE:表示数据集成离线同步任务。
  • DI_REALTIME:表示数据集成实时同步任务。

当前仅支持调用ListRefDISyncTasks接口选择查看一种类型的任务,不支持查询同步方案的任务类型

ProjectId Long 10000

DataWorks工作空间的ID。您可以登录DataWorks控制台,进入工作空间配置页面获取工作空间ID。

RefType String from

选择目标数据源作为数据集成同步任务的源端或目的端。取值如下:

  • from:目标数据源作为数据集成同步任务的源端。
  • to:目标数据源作为数据集成同步任务的目的端。
RegionId String cn-shanghai

服务所在的地域。例如,华东2(上海)是cn-shanghai,华北3(张家口)是cn-zhangjiakou。您无需填写RegionId,会根据调用的endpoint自动解析。

PageNumber Long 1

请求的数据页数,用于翻页。

PageSize Long 100

每页显示的数据条数。

返回数据

名称 类型 示例值 描述
Data Struct

返回的数据结果。

DISyncTasks Array of DISyncTasks

返回数据结果的数组信息。

通常,目标数据源会关联多个数据集成同步任务,调用ListRefDISyncTasks接口查询目标数据源关联的同步任务时,返回的结果为目标数据源所关联的同步任务的数组。如下信息为数组中一个同步任务的信息示例。

DiDestinationDatasource String [\"qcc_polardb2\"]

目标数据源所关联的当前同步任务的目的端数据源。

如果当前同步任务存在多个目的端数据源,则会以JSON数组的形式返回多个目的端数据源。例如,\"odps_writer\", \"mysql\"

当RefType参数取值为to时,即目标数据源作为数据集成同步任务的目的端,则当前参数的返回结果为目标数据源本身。

DiSourceDatasource String [\"odps_writer\"]

目标数据源所关联的当前同步任务的源端数据源。

如果当前同步任务存在多个源端数据源,则会以JSON数组的形式返回多个源端数据源。例如,\"odps_writer\", \"mysql\"

当RefType参数取值为from时,即目标数据源作为数据集成同步任务的源端,则当前参数的返回结果为目标数据源本身。

NodeId Long 100000

目标数据源所关联的当前数据集成同步任务的任务ID。

NodeName String abcd1234

目标数据源所关联的当前数据集成同步任务的任务名称。

TaskType String DI_OFFLINE

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

  • DI_OFFLINE:数据集成离线同步任务。
  • DI_REALTIME:数据集成实时同步任务。
RequestId String 0bc1411515937635973****

请求ID。用于定位日志,排查问题。

Success Boolean true

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

  • true:成功。
  • false:失败。

示例

请求示例

http(s)://[Endpoint]/?Action=ListRefDISyncTasks
&DatasourceName=mysql_datasource
&TaskType=DI_OFFLINE
&ProjectId=10000
&RefType=from
&RegionId=cn-shanghai
&PageNumber=1
&<公共请求参数>

正常返回示例

XML格式

<RequestId>0bc1411515937635973****</RequestId>
<Data>
    <DISyncTasks>
        <DiDestinationDatasource>[\"qcc_polardb2\"]</DiDestinationDatasource>
        <NodeName>abcd1234</NodeName>
        <DiSourceDatasource>[\"odps_writer\"]</DiSourceDatasource>
        <TaskType>DI_OFFLINE</TaskType>
        <NodeId>100000</NodeId>
    </DISyncTasks>
</Data>
<Success>true</Success>

JSON格式

{
    "RequestId": "0bc1411515937635973****",
    "Data": {
        "DISyncTasks": {
            "DiDestinationDatasource": "[\\\"qcc_polardb2\\\"]",
            "NodeName": "abcd1234",
            "DiSourceDatasource": "[\\\"odps_writer\\\"]",
            "TaskType": "DI_OFFLINE",
            "NodeId": 100000
        }
    },
    "Success": true
}

错误码

HttpCode 错误码 错误信息 描述
403 Forbidden.DI.NoPrivilege No access. 没有权限访问
500 InternalError.DI.Parameter A DI internal error occurred. 数据集成内部业务错误
400 Invalid.DI.Parameter The parameter is invalid. 参数错误
400 Invalid.DI.Parameter.File.Existed The file name already exists. 参数不合法,文件名已存在

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