UpdateIndex接口用于更新指定 Index 的描述、CpuQuota、ScalarIndex。
字段名 | 类型 | 是否必传 | 说明 |
|---|---|---|---|
CollectionName |
| 是 | 数据集名称 |
IndexName |
| 是 | 索引名称 |
Description |
| 否 | 索引描述 |
CpuQuota |
| 否 | 索引 CPU 用量 |
ShardConfig |
| 否 | 索引分片配置 |
ScalarIndexes |
| 否 | 标量过滤字段 注意 当前只允许新增标量过滤字段 |
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', Description: 'Index Description', // optional CpuQuota: 2, // optional ShardConfig: { ShardPolicy: vikingdb.index.ShardPolicy.Custom, ShardCount: 10 }, // optional，自定义分片 ShardConfig: { ShardPolicy: vikingdb.index.ShardPolicy.Auto, }, // optional，自动分片 Scalarindexes: ['Name'], // optinal })