ListDIJobs - 获取数据集成同步任务配置列表

更新时间:
复制为 MD 格式

查询数据集成新版任务列表,包括整库同步实时任务,整库同步离线任务,单表同步实时任务等数据集成任务。

接口说明

需要购买 DataWorks 基础版及以上版本才能使用。

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称

类型

必填

描述

示例值

PageNumber

integer

页码,从 1 开始,默认值为 1。

1

PageSize

integer

每页显示的数据条数,默认为 10 条,最大为 100 条。

10

Name

string

导出任务的名称。

名称必须唯一,即当前 DataWorks 工作空间中不能存在名称重复的导出任务。

test_export_01

SourceDataSourceType

string

源端数据源类型,不填代表不限制,枚举值:PolarDB,MySQL,Kafka,LogHub,Hologres,Oracle,OceanBase,MongoDB,RedShift,Hive,SQLServer,Doris,ClickHouse。

MySQL

DestinationDataSourceType

string

目标端数据源类型,不填代表不限制,枚举值:Hologres,OSS-HDFS,OSS,MaxCompute,LogHub,StarRocks,DataHub,AnalyticDB_For_MySQL,Kafka,Hive。

Hologres

MigrationType

string

同步类型,可选的枚举值有:

  • FullAndRealtimeIncremental(全量和实时增量)

  • RealtimeIncremental(实时增量)

  • Full(全量)

  • OfflineIncremental(离线增量)

  • FullAndOfflineIncremental(全量+离线增量)

FullAndRealtimeIncremental

ProjectId

integer

工作空间的 ID。

1967

SpecType

string

任务配置规范类型。可选 FILESPEC、CLASSIC、ALL。FILESPEC:基于结构化 filespec 的新版任务;CLASSIC:传统配置模式的任务;

返回参数

名称

类型

描述

示例值

object

Schema of Response

RequestId

string

Id of the request

7263E4AC-9D2E-5B29-B8AF-7C5012E92A41

PagingInfo

object

分页信息

TotalCount

integer

满足条件的数据总条数。

12

PageSize

integer

每页显示的条数

10

PageNumber

integer

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

1

DIJobs

array<object>

一组数据集成任务

object

一个数据集成任务

Id

integer

数据集成任务 ID。

32599

ProjectId

integer

任务所在 DataWorks 空间的 ID。

26442

JobName

string

任务名称。

mysql_to_holo_sync_35197

MigrationType

string

同步类型,可选的枚举值有:

  • FullAndRealtimeIncremental(全量和实时增量)

  • RealtimeIncremental(实时增量)

  • Full(全量)

  • OfflineIncremental(离线增量)

  • FullAndOfflineIncremental(全量+离线增量)

FullAndRealtimeIncremental

SourceDataSourceType

string

源端数据源类型,枚举值:PolarDB,MySQL,Kafka,Loghub,Hologres,Oracle,OceanBase,MongoDB,RedShift,Hive,SqlServer,Doris,ClickHouse。

Mysql

DestinationDataSourceType

string

目标端数据源类型,枚举值:Hologres,OSS-HDFS,OSS,MaxCompute,Loghub,STARROCKS,DataHub,ANALYTICDB_FOR_MYSQL,Kafka,Hive。

Hologres

JobStatus

string

同步状态,可选的枚举值:

  • Finished(运行成功已结束)

  • Initialized(初始化完成)

  • Stopped(已停止)

  • Failed(运行失败)

  • Running(运行中)

  • Stopping(停止中)

Running

DIJobId deprecated

integer

该字段已废弃,请使用 Id 字段。

32599

Owner

string

示例

正常返回示例

JSON格式

{
  "RequestId": "7263E4AC-9D2E-5B29-B8AF-7C5012E92A41",
  "PagingInfo": {
    "TotalCount": 12,
    "PageSize": 10,
    "PageNumber": 1,
    "DIJobs": [
      {
        "Id": 32599,
        "ProjectId": 26442,
        "JobName": "mysql_to_holo_sync_35197",
        "MigrationType": "FullAndRealtimeIncremental",
        "SourceDataSourceType": "Mysql",
        "DestinationDataSourceType": "Hologres",
        "JobStatus": "Running",
        "DIJobId": 32599,
        "Owner": ""
      }
    ]
  }
}

错误码

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

变更历史

更多信息,参考变更详情