全部产品
Search
文档中心

大数据开发治理平台 DataWorks:ListDIJobs - 查询数据集成新版任务列表

更新时间:Nov 21, 2024

查询数据集成新版任务列表,当前支持的任务类型包括:MySQL到Hologres整库实时解决方案。

接口说明

此列表接口仅返回任务基础信息,如需查看任务详细信息,请调用单任务查询接口 GetDIJob。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
dataworks:*list
*全部资源
*

请求参数

名称类型必填描述示例值
ProjectIdlong

工作空间的 ID。

1967
JobNamestring

任务名称,不填代表不限制,填写支持模糊查询。

mysql_to_holo_sync_8772
SourceDataSourceTypestring

源端数据源类型,不填代表不限制。

MySQL
DestinationDataSourceTypestring

目标端数据源类型,不填代表不限制。

Hologres
PageNumberinteger

页码,默认为 1。

1
PageSizeinteger

分页大小,默认为 10,最大支持 100。

10

返回参数

名称类型描述示例值
object

响应。

RequestIdstring

请求 ID。

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

任务分页结果。

TotalCountinteger

总记录数。

6
PageNumberinteger

页码。

1
PageSizeinteger

分页大小。

10
DIJobsarray<object>

任务列表。

DIJobobject

任务。

DIJobIdlong

任务 ID。

16626
ProjectIdlong

工作空间的 ID。

1967
JobNamestring

任务名称。

mysql_to_holo_sync_8772
MigrationTypestring

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

  • FullAndRealtimeIncremental(全量和实时增量)
  • RealtimeIncremental(实时增量)
  • Full(全量)
Full
SourceDataSourceTypestring

源端数据源类型,枚举值:MySQL。

MySQL
DestinationDataSourceTypestring

目标端数据源类型,枚举值:Hologres。

Hologres
JobStatusstring

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

  • Finished(运行成功已结束)
  • Initialized(初始化完成)
  • Stopped(已停止)
  • Failed(运行失败)
  • Running(运行中)
  • Stopping(停止中)
Finished

示例

正常返回示例

JSON格式

{
  "RequestId": "7263E4AC-9D2E-5B29-B8AF-7C5012E92A41",
  "DIJobPaging": {
    "TotalCount": 6,
    "PageNumber": 1,
    "PageSize": 10,
    "DIJobs": [
      {
        "DIJobId": 16626,
        "ProjectId": 1967,
        "JobName": "mysql_to_holo_sync_8772",
        "MigrationType": "Full",
        "SourceDataSourceType": "MySQL",
        "DestinationDataSourceType": "Hologres",
        "JobStatus": "Finished"
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
403Forbidden.AccessAccess is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.没有权限,请授权
429Throttling.ApiThe request for this resource has exceeded your available limit.对该资源的请求已超过您的可用上限。
429Throttling.SystemThe DataWorks system is busy. Try again later.DataWorks系统繁忙,请稍后再试。
429Throttling.UserYour request is too frequent. Try again later.您的请求过于频繁,请尝试放缓请求速度。
500InternalError.SystemAn internal system error occurred. Try again later.系统内部错误,请稍后再试。
500InternalError.UserId.MissingAn internal system error occurred. Try again later.系统内部错误,请稍后再试。

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

变更历史

变更时间变更内容概要操作
暂无变更历史