文档中心

向量数据库VikingDB

请输入

索引(index)

UpdateIndex

概述

UpdateIndex接口用于更新指定 Index 的描述、CpuQuota、ScalarIndex。

请求参数

字段名	类型	是否必传	说明
CollectionName	`string`	是	数据集名称
IndexName	`string`	是	索引名称
Description	`string`	否	索引描述
CpuQuota	`number`	否	索引 CPU 用量
ShardConfig	`ShardConfig`	否	索引分片配置
ScalarIndexes	`string[]`	否	标量过滤字段当前只允许新增标量过滤字段

ShardConfig

type ShardConfig =
  | {
      ShardPolicy: ShardPolicy.Custom;
      ShardCount: number;
    }
  | {
      ShardPolicy: ShardPolicy.Auto;
    };

响应参数

declare class VikingdbResponse {
  readonly OriginalRequest: string;
  readonly LogId: string;
  constructor(
    OriginalRequest: string,
    LogId: string
  );
}

参考示例

以下示例分别展示自定义分片和自动分片，两种策略不要放在同一个请求对象中。

import { vikingdb } from '@volcengine/openapi'

declare const service: vikingdb.VikingdbService // 替换为你初始化好的实例

await service.index.UpdateIndex({
  CollectionName: 'test_collection_1',
  IndexName: 'test_index_1',
  ShardConfig: {
    ShardPolicy: vikingdb.index.ShardPolicy.Custom,
    ShardCount: 10,
  },
  ScalarIndexes: ['Name'],
})

await service.index.UpdateIndex({
  CollectionName: 'test_collection_1',
  IndexName: 'test_index_2',
  ShardConfig: { ShardPolicy: vikingdb.index.ShardPolicy.Auto },
})

示例修正

参考示例已拆分为自定义分片与自动分片两个独立 UpdateIndex 调用，移除了单个对象内重复的 ShardConfig 键。

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

这个页面对您有帮助吗？

有用

无用

向量数据库VikingDB

ShardConfig #

示例修正 #

ShardConfig

示例修正