文档中心

向量数据库VikingDB

请输入

任务(Task)

deleteVikingdbTask

概述

删除指定任务，删除后任务将终止。

方法定义

Python SDK 通过 VIKINGDBApi().delete_vikingdb_task(request) 调用该接口，request 类型为 volcenginesdkvikingdb.DeleteVikingdbTaskRequest。

请求参数

参数	类型	是否必选	说明
task_id	str	是	任务 ID，对应 API 字段 `TaskId`，可从创建/查询任务接口获取。

返回参数

参数	类型	描述
message	str	操作结果描述，对应 API 字段 `Message`。

示例

运行示例前，请完成以下准备：
安装 VikingDB V2 Python SDK，将完整代码保存为 example.py 后执行 python3 example.py。
AK/SK 在火山引擎控制台“密钥管理”中创建；Host 和 Region 取自地域和访问域名。请在运行前配置代码读取的 VIKINGDB_AK、VIKINGDB_SK、VIKINGDB_HOST、VIKINGDB_REGION 等环境变量。
Collection、Index 名称从 VikingDB 控制台对应资源详情获取，Task ID 使用创建或查询任务接口返回的 ID。请将代码中的 <YOUR_...> 占位符全部替换为真实值。
若示例包含 TOS 路径，请从 TOS 控制台确认桶名和对象路径，并替换为真实的 <YOUR_BUCKET_NAME>/<YOUR_TOS_PATH>。

import os
import volcenginesdkcore
import volcenginesdkvikingdb as vdb
from volcenginesdkvikingdb.api.vikingdb_api import VIKINGDBApi

configuration = volcenginesdkcore.Configuration()
configuration.ak = os.environ["VIKINGDB_AK"]
configuration.sk = os.environ["VIKINGDB_SK"]
configuration.region = os.environ["VIKINGDB_REGION"]
configuration.host = os.environ["VIKINGDB_HOST"]
configuration.scheme = "https"
volcenginesdkcore.Configuration.set_default(configuration)

client = VIKINGDBApi()

request = vdb.DeleteVikingdbTaskRequest(task_id="<YOUR_TASK_ID>")
response = client.delete_vikingdb_task(request)
print(response.message or "delete task finished")

最近更新时间：2026.09.08 12:02:57

这个页面对您有帮助吗？

有用

无用