更新离线任务-UpdateVikingdbTask--向量数据库VikingDB-火山引擎

文档中心

立即注册

导航

向量数据库VikingDB

更新离线任务-UpdateVikingdbTask

最近更新时间：2025.09.30 16:07:18首次发布时间：2025.08.15 11:30:52

概述

接口用于对指定离线任务的更新

地域功能开放说明

地域	离线任务Task处理
华北	支持
华东	支持
华南	支持
柔佛	暂不支持，正在开发中

接口升级说明

对应的V1接口为：https://www.volcengine.com/docs/84313/1399338
使用区别：

	V2接口	V1接口
参数命名风格	驼峰（TaskId）	下划线（`index_name`）

请求接口

说明

请求向量数据库 VikingDB 的 OpenAPI 接口时，可以使用 ak、sk 构造签名进行鉴权。请参见控制面API调用流程，复制调用示例并填入必要信息

请求参数

请求参数Action取值：UpdateVikingdbTask
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	描述
TaskId	String	是	任务ID
TaskStatus	String	是	只有 confirm 状态可以更新，且只能更新为 confirmed

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
Message	String	success	操作结果信息

请求示例

action = "UpdateVikingdbTask",
body = {
  "TaskId": "a7n44e7Y",
  "TaskStatus": "confirmed"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "2025060910243616613011919613C0B7",
    "Action": "UpdateVikingdbTask",
    "Version": "2025-06-09",
    "Service": "vikingdb",
    "Region": "cn-beijing"
  },
  "Result": {
    "Message": "success"
  }
}

错误码

错误码请参见公共错误码文档。