文档中心

向量数据库VikingDB

请输入

任务创建

TOS文件数据导入任务

概述

将 TOS 中的文件数据导入到 Collection 中，要求文件的列名必须和 Collection fields 重合，否则会解析失败
使用前请先授权 VikingDB 跨服务访问 TOS 去授权

请求参数

参数名	类型	必须	说明	子字段	类型	必选	说明
task_type	string	是	任务类型，填入TaskType.Data_Import
task_params	json	是	任务参数	collection_name	string	是	Collection 名称，必填
				file_type	string	是	文件类型, json 或者 parquet，必填
				tos_path	string	是	TOS 路径，格式：{桶名}/{路径}，注意不是域名。必填
				ignore_error	bool	否	设置为 true 时遇到错误数据会继续解析文件，默认为 false

示例

运行示例前，请完成以下准备：
安装 VikingDB Python SDK，将完整代码保存为 example.py 后执行 python3 example.py。
将 <YOUR_HOST>、<YOUR_REGION> 和 <YOUR_SCHEME> 替换为地域和访问域名中与实例一致的服务地址、地域和协议。
将 <YOUR_AK>、<YOUR_SK> 替换为火山引擎控制台“密钥管理”中创建的 Access Key ID 和 Secret Access Key；请勿把真实凭证提交到代码仓库。
将 Collection、Index、Task 等资源占位符替换为控制台中对应资源的名称或接口返回的 ID。若示例包含 TOS 路径，请从 TOS 控制台确认桶名和对象路径，并使用 tos://<YOUR_BUCKET_NAME>/<YOUR_OBJECT_KEY> 或文档要求的路径格式。

请求参数

运行示例前，请将其中的 TOS Bucket、对象路径和本地路径占位符替换为实际值。

from volcengine.viking_db import *

vikingdb_service = VikingDBService()
vikingdb_service.set_ak()
vikingdb_service.set_sk()
task_params = {
    "collection_name": "<YOUR_COLLECTION_NAME>", # collection 名称
    "file_type": "parquet", # 文件格式
    "tos_path": "<YOUR_BUCKET_NAME>/<YOUR_TOS_PATH>" # tos 路径，需要提前授权 VikingDB 访问 TOS 权限
}
task_id = vikingdb_service.create_task(TaskType.Data_Import, task_params)

返回值

属性	说明
task_id	uuid

返回说明补充

返回参数补充

字段	类型	含义
`code`	int	业务状态码；成功时为 0。
`message`	string	状态说明。
`request_id`	string	请求唯一标识。
`task_id`	string	创建成功的离线任务唯一标识，后续用于查询、更新或删除任务。

错误处理补充

返回结构补充

字段	类型	含义
`code`	int	业务状态码；成功时为 0。
`message`	string	状态说明或错误信息。
`request_id`	string	请求唯一标识，用于问题排查。
`data`	object / array	接口业务数据；没有业务数据时可为空。

错误码

本接口的业务错误码、触发条件和处理建议统一参见向量库 V1 错误码。排查时请保留响应中的 request_id。

最近更新时间：2026.09.08 15:30:03

这个页面对您有帮助吗？

有用

无用

向量数据库VikingDB

请求参数 #

返回值 #

返回说明补充 #

返回参数补充 #

错误处理补充 #

返回结构补充 #

错误码 #

请求参数

返回值

返回说明补充

返回参数补充

错误处理补充

返回结构补充

错误码