创建导出任务¶
创建导出任务,将文件或处理结果写入目标连接器。成功响应表示任务已受理;请使用任务 ID 继续查看实际处理状态。
POST https://api.moi.matrixorigin.cn/v5/export/task/create
调用前准备¶
请求体¶
将 $AI_STUDIO_API_KEY、$WORKSPACE_ID、$CONNECTOR_ID 和示例中的文件信息替换为实际值。每个请求只填写一个目标配置对象。
curl -X POST "https://api.moi.matrixorigin.cn/v5/export/task/create" \
-H "X-API-Key: $AI_STUDIO_API_KEY" \
-H "X-Workspace-ID: $WORKSPACE_ID" \
-H 'Content-Type: application/json' \
-d @- <<EOF
{
"task_name": "export-orders",
"creator": "data-engineer",
"connector_id": "$CONNECTOR_ID",
"connector_name": "target-mo",
"type": 3,
"config": {
"mo_config": {
"database_name": "analytics",
"table_name": "orders",
"new_table": true,
"duplicated_strategy": 3,
"column": {
"export_column": [{
"source_column": "content",
"mapping_column": "content"
}],
"combine_column": []
}
}
},
"files": [{
"file_id": "file_01",
"ref_file_id": "raw-file_01",
"parsed_file_id": "parsed-file_01",
"full_path": ["volume_01", "orders.csv"],
"is_raw": false
}]
}
EOF
OSS 使用 type 为 4,标准 S3 使用 5;两者均填写 s3_config。
curl -X POST "https://api.moi.matrixorigin.cn/v5/export/task/create" \
-H "X-API-Key: $AI_STUDIO_API_KEY" \
-H "X-Workspace-ID: $WORKSPACE_ID" \
-H 'Content-Type: application/json' \
-d @- <<EOF
{
"task_name": "export-to-s3",
"creator": "data-engineer",
"connector_id": "$CONNECTOR_ID",
"connector_name": "target-s3",
"type": 5,
"config": {
"s3_config": {
"path": "exports/",
"need_compress": true,
"compress_method": "gzip"
}
},
"files": [{
"file_id": "file_01",
"full_path": ["volume_01", "orders.csv"],
"is_raw": true
}]
}
EOF
直接调用 API 时可使用 Dify 知识库目标;当前创建页面不提供该目标入口。
curl -X POST "https://api.moi.matrixorigin.cn/v5/export/task/create" \
-H "X-API-Key: $AI_STUDIO_API_KEY" \
-H "X-Workspace-ID: $WORKSPACE_ID" \
-H 'Content-Type: application/json' \
-d @- <<EOF
{
"task_name": "export-to-dify",
"creator": "data-engineer",
"connector_id": "$CONNECTOR_ID",
"connector_name": "target-dify",
"type": 6,
"config": {
"dify_config": {
"dataset_id": "dataset-001",
"dataset_name": "support-kb",
"embedding_model": "text-embedding-model"
}
},
"files": [{
"file_id": "file_01",
"full_path": ["volume_01", "orders.csv"],
"is_raw": false
}]
}
EOF
参数 |
类型 |
是否必填 |
说明 |
|---|---|---|---|
|
string |
否 |
导出任务名称。 |
|
string |
否 |
创建者标识。 |
|
string |
是 |
目标连接器 ID。 |
|
string |
否 |
保存到任务中的目标连接器名称。 |
|
integer |
是 |
MatrixOne 目标使用 |
|
object |
是 |
目标配置;本场景只填写 |
|
object |
是 |
MatrixOne 目标配置。 |
|
string |
否 |
目标数据库名称。 |
|
string |
否 |
目标表名称。 |
|
boolean |
否 |
是否新建目标表。 |
|
integer |
否 |
重复数据处理方式: |
|
object |
否 |
导出列配置。 |
|
array of object |
否 |
源列与目标列的映射。 |
|
string |
否 |
源列名。 |
|
string |
否 |
目标列名。 |
|
array of string |
否 |
要合并处理的源列;不合并时传空数组。 |
|
array of object |
是 |
待导出文件,至少一项。 |
|
string |
是 |
源文件 ID。 |
|
string |
否 |
关联的原始文件 ID。 |
|
string |
否 |
关联的解析产物文件 ID。 |
|
array of string |
否 |
从卷根目录到文件的完整路径。 |
|
boolean |
否 |
|
参数 |
类型 |
是否必填 |
说明 |
|---|---|---|---|
|
string |
否 |
导出任务名称。 |
|
string |
否 |
创建者标识。 |
|
string |
是 |
目标连接器 ID。 |
|
string |
否 |
保存到任务中的目标连接器名称。 |
|
integer |
是 |
标准 S3 目标使用 |
|
object |
是 |
目标配置;本场景只填写 |
|
object |
是 |
对象存储目标配置。 |
|
string |
否 |
存储桶内的目标路径。 |
|
boolean |
否 |
是否压缩本次导出内容。 |
|
string |
否 |
压缩方式。 |
|
array of object |
是 |
待导出文件,至少一项。 |
|
string |
是 |
源文件 ID。 |
|
array of string |
否 |
从卷根目录到文件的完整路径。 |
|
boolean |
否 |
|
参数 |
类型 |
是否必填 |
说明 |
|---|---|---|---|
|
string |
否 |
导出任务名称。 |
|
string |
否 |
创建者标识。 |
|
string |
是 |
目标连接器 ID。 |
|
string |
否 |
保存到任务中的目标连接器名称。 |
|
integer |
是 |
Dify 知识库目标使用 |
|
object |
是 |
目标配置;本场景只填写 |
|
object |
是 |
Dify 知识库目标配置。 |
|
string |
否 |
目标知识库 ID。 |
|
string |
否 |
保存到任务中的知识库名称。 |
|
string |
否 |
知识库使用的嵌入模型标识。 |
|
array of object |
是 |
待导出文件,至少一项。 |
|
string |
是 |
源文件 ID。 |
|
array of string |
否 |
从卷根目录到文件的完整路径。 |
|
boolean |
否 |
|
成功响应¶
{
"code": "OK",
"msg": "OK",
"data": {
"id": "export-task-123",
"name": "export-orders",
"connector_name": "target-mo",
"type": 3,
"status": 1,
"export_source": [["volume_01", "orders.csv"]],
"create_time": "2026-08-28T10:00:00Z",
"end_time": null,
"fileSuccess": 0,
"fileFail": 0
}
}
字段 |
类型 |
说明 |
|---|---|---|
|
string |
成功时为 |
|
string |
成功时为 |
|
object |
新建任务。 |
|
string |
任务 ID。 |
|
string |
任务名称。 |
|
string |
目标连接器名称。 |
|
integer |
导出目标类型。 |
|
integer |
任务状态。 |
|
array of array of string |
来源文件路径集合。 |
|
string 或 null |
创建时间。 |
|
string 或 null |
结束时间。 |
|
integer |
已成功导出的文件数。 |
|
integer |
导出失败的文件数。 |
错误响应¶
{
"code": "ErrParamInvalid",
"msg": "请求参数无效",
"data": null
}
字段 |
类型 |
说明 |
|---|---|---|
|
string |
错误代码。 |
|
string |
可读错误信息。 |
|
null |
错误响应中为 |
后续操作¶
记录 data.id。使用查看导出任务状态和查看导出任务文件列表确认文件处理结果。