collectionName

string

是

指定创建索引所属的 Collection 名称。

• 只能使用英文字母、数字、下划线_，并以英文字母开头，不能为空。
• 长度要求：[1, 128]。
• Collection 名称不能重复。

indexName

string

是

指定创建的索引 Index 名称。

• 只能使用英文字母、数字、下划线_，并以英文字母开头，不能为空。
• 长度要求：[1, 128]。
• 索引名称不能重复。

cpuQuota

int

否

2

索引检索消耗的 CPU 配额，格式为正整数。

• 与吞吐量有关，和延迟无关，1CPU 核约为 100QPS。
• N个分片数量N倍的 CPU 消耗；如果检索消耗的 CPU 超过配额，该索引会被限流。
• 取值范围：[2, 10240]。

description

string

否

”“

索引的自定义描述。

scalarIndex

array

否

None

标量字段列表。

• scalarIndex 默认为 None，表示所有字段构建到标量索引。
• scalarIndex 为 [] 时，表示无标量索引。
• scalarIndex 为非空列表时，表示将列表内字段构建到标量索引。

如果标量字段进入标量索引，主要用于范围过滤和枚举过滤，会占用额外资源：

• 范围过滤：float32、int64
• 枚举过滤：int64、string、list、list、bool

如果标量字段不进入标量索引，仍支持作为正排字段选取使用和部分正排计算。

shardCount

int

否

1

分片数。索引分片是指在大规模数据量场景下，可以把索引数据切分成多个小的索引块，分发到同一个集群不同节点进行管理，每个节点负责存储和处理一部分数据，可以将查询负载分散到不同的节点上，并发的进行处理。当一个节点发生故障时，系统可以自动将其上的分片数据迁移到其他的正常节点上，保证稳定性，以实现数据的水平扩展和高性能的读写操作。

• 取值范围：[1, 256]。
• 默认为1，分片数预估参考：数据预估数据量/3000万。