向量数据库VikingDB
向量数据库VikingDB
- 文档首页
向量数据库VikingDBVikingDB 向量库向量库历史版本（V1）API V1参考离线任务(Task)任务列表
复制全文
下载 pdf
文档反馈
问问助手获取多个task的信息，最多一次性展示20条
字段名 | 类型 | 必须 | 说明 |
|---|---|---|---|
collection_name | string | 否 | 过滤collection 相关的任务 |
task_status | string | 否 | 过滤符合 task_status 的任务 |
task_type | string | 否 | 过滤符合 task_type 的任务 |
curl -i -X GET \ -H 'Content-Type: application/json' \ -H 'Authorization: HMAC-SHA256 ***' \ https://api-vikingdb.volces.com/api/task/list \ -d '{ "task_type": "data_export" }'
字段 | 类型 | 子字段 | 类型 | 子字段说明 |
|---|---|---|---|---|
tasks | list | task_id | string | 任务ID |
task_type | string | 任务类型 | ||
task_status | string | 任务状态 | ||
update_person | string | 任务更新人 | ||
update_time | string | 任务信息更新时间 | ||
create_time | string | 任务信息创建时间 | ||
process_info | map | 任务处理信息，例如进度等 | ||
task_params | map | 任务配置信息，用户填入 | ||
total | 总共 task 数量 |
- task_type 类型包括
data_import | 数据导入任务 |
|---|---|
data_export | 数据导出任务 |
filter_update | 数据过滤更新任务 |
filter_delete | 数据过滤删除任务 |
- task_status 任务状态包括
init | queued | running | done | fail |
|---|---|---|---|---|
初始化中 | 排队中 | 执行中 | 完成 | 失败 |
- process_info 任务信息包括
字段 | 类型 | 说明 |
|---|---|---|
task_progress | string | 任务进度 例如50% |
err_msg | string | 任务错误信息 |
sampled_data | list | 采样5条数据用于展示 |
sampled_timestamp | int64 | 采样的时间戳，后写入的数据不会被处理 |
scan_data_count | int64 | 当前扫描数据量 |
total_data_count | int64 | collection 数据总条数(预估） |
total_filter_count | int64 | 已经过滤出的数据 |
参数说明补充
create_time 与 update_time 为字符串，格式为 YYYY-MM-DD HH:mm:ss，时区为 Asia/Shanghai（UTC+8）。解析时不要按本地系统时区二次偏移。
参数说明补充
create_time 与 update_time 为字符串，格式为 YYYY-MM-DD HH:mm:ss，时区为 Asia/Shanghai（UTC+8）。解析时不要按本地系统时区二次偏移。
返回说明补充
total 类型为 int64，表示符合当前筛选条件的任务总数，用于计算分页数量。
返回说明补充
任务列表请求支持 limit（int，默认 20，最大 20）和 offset（int，默认 0，最小 0）。下一页令 offset = offset + limit；当返回条数小于 limit 或 offset 达到 total 时停止翻页。
参数说明补充
sampled_timestamp 类型为 int64，单位为毫秒，是 Unix Epoch 时间戳；晚于该采样点写入的数据不会被本次任务处理。
请求接口补充
请求接口
- HTTP 方法：
GET - Host：
api-vikingdb.volces.com - 请求路径：
/api/task/list - 鉴权：使用 V1 HMAC-SHA256 签名。
返回说明补充
成功响应示例
{"code":0,"message":"success","request_id":"req-xxx","data":[{"task_id":"task-xxx","task_type":"data_import","task_status":"done","create_time":"2026-08-20 10:00:00","update_time":"2026-08-20 10:05:00"}],"total":1}
鉴权说明补充
鉴权说明
示例中的 Authorization: HMAC-SHA256 *** 不是固定 Token。请从火山引擎控制台“密钥管理”获取 AK/SK，并根据 HTTP 方法、URI、查询参数、规范化请求头和请求体摘要生成 HMAC-SHA256 签名。完整步骤参见API 签名调用指南。使用官方 SDK 时由 SDK 自动完成签名，不要在代码或文档中写入真实密钥。
错误处理补充
返回结构补充
| 字段 | 类型 | 含义 |
|---|---|---|
code | int | 业务状态码；成功时为 0。 |
message | string | 状态说明或错误信息。 |
request_id | string | 请求唯一标识，用于问题排查。 |
data | object / array | 接口业务数据；没有业务数据时可为空。 |
错误码
本接口的业务错误码、触发条件和处理建议统一参见向量库 V1 错误码。排查时请保留响应中的 request_id。