更新索引-UpdateVikingdbIndex--向量数据库VikingDB-火山引擎

文档中心

立即注册

导航

向量数据库VikingDB

更新索引-UpdateVikingdbIndex

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

概述

接口用于对指定索引的更新

接口升级说明

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

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

注：QPS限流是以数据条数计算，V1与V2接口的限流行为完全相同。

请求接口

说明

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

请求参数

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

参数	类型	是否必填	描述
ProjectName	String	否	项目名称
CollectionName	String	2选1	数据集名称
ResourceId	String	2选1	数据集资源ID。请求必须指定ResourceId和CollectionName其中之一。
IndexName	String	是	索引名称
ShardPolicy	String	否	索引分片类型可选值为auto/custom，auto为自动分片、custom为自定义分片。索引分片是指在大规模数据量场景下，将索引数据均分成多个小的索引数据块，并分发到同一个集群不同节点进行管理，每个节点负责存储和处理一部分数据，查询会同时请求不同节点上的索引数据块。由于单节点的容量有限，无法将索引全部数据存放到单节点中，因此需要设置合适的索引分片数，否则会影响索引到数据的时效性。另，分片数与成本相关，分片数越多成本越高。
Description	String	否	索引的自定义描述。
ScalarIndex	Array of String	否	标量字段列表，用于设置需要构建到标量索引的字段。 scalar_index 默认为 None，表示所有字段构建到标量索引。 scalar_index 为 [] 时，表示无标量索引。 scalar_index 为非空列表时，表示将列表内字段构建到标量索引。如果标量字段进入标量索引，主要用于范围过滤和枚举过滤，会占用额外资源：范围过滤：float32、int64 枚举过滤：int64、string、list、list、bool 如果标量字段不进入标量索引，仍支持作为正排字段选取使用和部分正排计算。
ShardCount	Integer	否	自定义分片数。当shard_policy为auto时，shard_count不生效。当shard_policy为custom时，shard_count。取值范围：[1, 256]。默认为1，分片数预估参考：数据预估数据量/3000万。
CpuQuota	Integer	否	索引检索消耗的 CPU 配额，格式为正整数。与吞吐量有关，和延迟无关，1CPU 核约为 100QPS。 N个分片数量N倍的 CPU 消耗；如果检索消耗的 CPU 超过配额，该索引会被限流。取值范围：[1, 10240]。

返回参数

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

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

请求示例

action = "UpdateVikingdbIndex"
body = {
  "Description": "it is a test index",
  "CpuQuota": 10,
  "CollectionName": "test_coll",
  "IndexName": "test_index_1"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20250527175413216098005053ADD0C8",
    "Action": "UpdateVikingdbIndex",
    "Version": "2025-06-09",
    "Service": "vikingdb",
    "Region": "cn-beijing"
  },
  "Result": {
    "Message": "success"
  }
}

错误码

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