查看导入任务列表¶
列出当前工作区中有读取权限的导入任务。保存响应中的任务 ID,以便查看详情、文件和运行记录。
GET https://moi.matrixorigin.cn/newmoi/task/list
调用前准备¶
查询参数¶
将 $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"
参数 |
类型 |
是否必填 |
说明 |
|---|---|---|---|
|
integer |
否 |
页码;省略或小于 1 时使用第 1 页。 |
|
integer |
否 |
每页条数;省略或小于 1 时使用 20。 |
参数 |
类型 |
是否必填 |
说明 |
|---|---|---|---|
|
integer |
否 |
页码。 |
|
integer |
否 |
每页条数。 |
|
string |
否 |
匹配任务名称或创建者。 |
|
integer(整数数组) |
否 |
任务状态:0 未知、1 进行中、2 暂停中、3 已暂停、4 已完成、5 已失败。 |
|
string(字符串数组) |
否 |
来源连接器 ID。 |
|
integer(整数数组) |
否 |
导入周期类型;4 表示一次性。 |
|
string |
否 |
排序字段。可用 |
|
boolean |
否 |
是否降序;省略时为 true。 |
参数 |
类型 |
是否必填 |
说明 |
|---|---|---|---|
|
integer(整数数组) |
否 |
来源连接器类型代码。 |
参数 |
类型 |
是否必填 |
说明 |
|---|---|---|---|
|
integer |
否 |
下一页页码。 |
|
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
}
}
字段 |
类型 |
说明 |
|---|---|---|
|
string |
成功时为 |
|
string |
成功时为 |
|
object(对象数组) |
当前调用者可读取的任务;完整字段见导入任务返回字段。 |
|
string |
任务 ID。 |
|
string |
任务名称。 |
|
integer |
任务配置类型。 |
|
string |
来源连接器 ID。 |
|
string |
来源连接器名称。 |
|
string |
目标数据卷 ID。 |
|
integer |
任务当前状态。 |
|
integer |
任务总行数。 |
|
integer |
已导入行数。 |
|
integer |
符合筛选条件的任务总数。 |
错误响应¶
{
"code": "ErrForbidden",
"msg": "permission denied",
"data": null
}
字段 |
类型 |
说明 |
|---|---|---|
|
string |
错误代码。 |
|
string |
可读错误信息。 |
|
null |
错误响应中为 |
后续操作¶
使用目标任务的 data.tasks[].id 查看导入任务详情。