查看导入任务列表

列出当前工作区中有读取权限的导入任务。保存响应中的任务 ID,以便查看详情、文件和运行记录。

GET https://moi.matrixorigin.cn/newmoi/task/list

调用前准备

准备有目标工作区访问权限的个人访问令牌目标工作区 ID

查询参数

$AI_STUDIO_API_KEY$WORKSPACE_ID 替换为实际值。

curl "https://moi.matrixorigin.cn/newmoi/task/list?page=1&page_size=20" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID"

重复出现的查询参数表示多个取值。

curl "https://moi.matrixorigin.cn/newmoi/task/list?page=1&page_size=20&keyword=orders&status=4&status=5&source_connector_ids=conn_01&load_interval_types=4&order_by=ended_at&is_desc=false" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID"

使用 connector_sources 按来源连接器类型筛选;该参数可重复出现。

curl "https://moi.matrixorigin.cn/newmoi/task/list?connector_sources=5" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID"

page 加 1,直至累计读取的任务数达到响应中的 data.total,或下一页的 data.tasks 为空。

curl "https://moi.matrixorigin.cn/newmoi/task/list?page=2&page_size=20" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID"

参数

类型

是否必填

说明

page

integer

页码;省略或小于 1 时使用第 1 页。

page_size

integer

每页条数;省略或小于 1 时使用 20。

参数

类型

是否必填

说明

page

integer

页码。

page_size

integer

每页条数。

keyword

string

匹配任务名称或创建者。

status

integer(整数数组)

任务状态:0 未知、1 进行中、2 暂停中、3 已暂停、4 已完成、5 已失败。

source_connector_ids

string(字符串数组)

来源连接器 ID。

load_interval_types

integer(整数数组)

导入周期类型;4 表示一次性。

order_by

string

排序字段。可用 namecreated_atupdated_atstarted_atended_atstatus

is_desc

boolean

是否降序;省略时为 true。

参数

类型

是否必填

说明

connector_sources

integer(整数数组)

来源连接器类型代码。

参数

类型

是否必填

说明

page

integer

下一页页码。

page_size

integer

每页条数。

成功响应

{
  "code": "OK",
  "msg": "OK",
  "data": {
    "tasks": [
      {
        "id": "task_01",
        "name": "import_orders",
        "config_type": 1,
        "source_connector_id": "conn_01",
        "connector_name": "orders_s3",
        "volume_id": "vol_01",
        "status": 1,
        "total_rows": 100,
        "imported_rows": 0
      }
    ],
    "total": 1
  }
}

字段

类型

说明

code

string

成功时为 OK

msg

string

成功时为 OK

data.tasks

object(对象数组)

当前调用者可读取的任务;完整字段见导入任务返回字段

data.tasks.id

string

任务 ID。

data.tasks.name

string

任务名称。

data.tasks.config_type

integer

任务配置类型。

data.tasks.source_connector_id

string

来源连接器 ID。

data.tasks.connector_name

string

来源连接器名称。

data.tasks.volume_id

string

目标数据卷 ID。

data.tasks.status

integer

任务当前状态。

data.tasks.total_rows

integer

任务总行数。

data.tasks.imported_rows

integer

已导入行数。

data.total

integer

符合筛选条件的任务总数。

错误响应

{
  "code": "ErrForbidden",
  "msg": "permission denied",
  "data": null
}

字段

类型

说明

code

string

错误代码。

msg

string

可读错误信息。

data

null

错误响应中为 null

后续操作

使用目标任务的 data.tasks[].id 查看导入任务详情

最后更新于