文档首页/ 数据治理中心 DataArts Studio/ API参考/ 数据目录API/ 元数据采集任务接口/ 查询采集任务列表
更新时间：2024-11-22 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询采集任务列表

功能介绍

查询采集任务列表。

调用方法

请参见如何调用API。

URI

POST /v3/{project_id}/metadata/tasks/search

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，获取方法请参见项目ID和账号ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token，使用Token认证时必选。通过调用IAM服务的“获取用户Token”接口获取响应消息头中X-Subject-Token的值。

workspace

是

String

工作空间ID，获取方法请参见实例ID和工作空间ID。
表3 请求Body参数

参数

是否必选

参数类型

描述

user_name

否

String

创建人。

name

否

String

任务名。

data_source_type

否

String

数据源类型。

data_connection_id

否

String

数据连接id。

start_time

否

String

开始时间。

end_time

否

String

结束时间。

directory_id

否

String

目录id。

bucket_name

否

String

桶名。

limit

否

Integer

分页参数limit，默认值：10。

offset

否

Integer

分页参数offset，默认值：0。

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

count

Integer

查询采集任务数量。

total_records

Integer

同一projectId下已创建采集任务数量。

max_records

Integer

同一projectId下允许创建采集任务数量。

resources

Array of MetadataCollectionTask objects

采集任务列表。
表5 MetadataCollectionTask

参数

参数类型

描述

id

String

任务id。

name

String

任务名称。

description

String

任务描述。

user_id

String

用户id。

create_time

String

创建时间。

project_id

String

产品id。

dir_id

String

目录id。

schedule_config

SchedulerInfo object

调度信息。

parameter_config

Array of CustomMetadata objects

自定义元数据信息。

update_time

String

修改时间。

user_name

String

用户名。

path

String

路径。

last_run_time

String

最后一次执行时间。

start_time

String

开始时间。

end_time

String

结束时间。

next_run_time

String

下一次执行时间。

duty_person

String

责任人。

update_type

String

修改类型。

data_source_type

String

数据来源类型。

task_config

Object

任务信息Map(String, Object)。key：属性名称，value：属性值。

data_source_workspace_id

String

数据来源工作空间id。
表6 SchedulerInfo

参数

参数类型

描述

cron_expression

String

表达式。

end_time

String

结束时间。

max_time_out

Integer

最大超时时间。

interval

String

间隔。

schedule_type

String

调度类型。

start_time

String

开始时间。

job_id

Integer

工作id。

enabled

Integer

启用。
表7 CustomMetadata

参数

参数类型

描述

description

String

描述。

type

String

类型。

task_id

String

任务id。

状态码： 400

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

状态码： 401

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

状态码： 403

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

状态码： 404

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

{
  "user_name" : "userName",
  "name" : null,
  "data_source_type" : null,
  "data_connection_id" : null,
  "start_time" : null,
  "end_time" : null,
  "directory_id" : "e4248d66-c376-4f1b-a576-e4d1c6838d83",
  "bucket_name" : null,
  "limit" : 10,
  "offset" : 1
}

响应示例

状态码： 200

OK。

{
  "count" : 1,
  "total_records" : 1,
  "max_records" : 100,
  "resources" : [ {
    "create_time" : "1663722819809",
    "data_source_type" : "HIVE",
    "data_source_workspace_id" : null,
    "description" : null,
    "dir_id" : "0",
    "duty_person" : "user_demo",
    "end_time" : "0",
    "id" : "8a948047835b945101835d9b90e1010f",
    "last_run_time" : "1663723446000",
    "name" : "hive921",
    "next_run_time" : "0",
    "parameter_config" : [ ],
    "path" : null,
    "project_id" : null,
    "schedule_config" : [ {
      "cron_expression" : null,
      "enabled" : 4,
      "end_time" : null,
      "interval" : null,
      "job_id" : 262070,
      "max_time_out" : 60,
      "schedule_type" : "RUN_ONCE",
      "start_time" : null
    } ],
    "start_time" : "0",
    "task_config" : [ ],
    "update_time" : "1663722819809",
    "update_type" : null,
    "user_id" : "0833a573fe80d5401f6dc010a775569a",
    "user_name" : "user_demo"
  } ]
}

状态码

状态码

描述

200

OK。

400

BadRequest。

401

Unauthorized。

403

Forbidden。

404

Not Found。
父主题： 元数据采集任务接口

相关文档