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

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',
  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
})