文档中心

GetIndex

最近更新时间：2024.04.16 13:11:55

首次发布时间：2023.12.21 19:03:20

概述

GetIndex 用于查询索引 Index 详情。

请求参数

参数	类型	是否必选	参数说明
collectionName	string	是	指定要查询索引所属的 Collection 名称。只能使用英文字母、数字、下划线_，并以英文字母开头，不能为空。长度要求：[1, 128]。 Collection 名称不能重复。
indexName	string	是	指定要查询的 Index 名称。只能使用英文字母、数字、下划线_，并以英文字母开头，不能为空。长度要求：[1, 128]。索引名称不能重复。

参数

类型

是否必选

参数说明

collectionName

string

是

指定要查询索引所属的 Collection 名称。

indexName

string

是

指定要查询的 Index 名称。

示例

请求参数

index, err := service.GetIndex("go", "goIndex")
if err != nil {
    fmt.Println(err)
}

Go 调用执行上面的任务，返回 Index 结构体地址 (*Index)。Index 结构体包含的属性如下表所示。

属性	类型	说明
CollectionName	string	显示索引所属的 Collection 名称。
IndexName	string	显示索引 Index 名称。
Description	string	显示索引的描述。
CpuQuota	int	显示索引线上检索消耗的 CPU 配额。
PartitionBy	string	PartitionBy 用于划分子索引 partition，对应字段名称 FieldName。根据某个标量字段可以将数据集划分成不同的子数据集，不同的子数据集构建为不同的子索引，实现混合检索时在子索引内检索并减少过滤，从而提升检索性能。
VectorIndex	VectorIndexParams	向量索引参数。
ScalarIndex	list<string>	标量索引字段列表。
Status	String	索引状态。取值如下： INIT：初始化，在构建或加载中。 CHANGING：变更中，在变更构建或加载中 READY：已上线，可以正式提供服务。
ShardCount	int	分片数。
CreateTime	string	索引创建时间。
UpdateTime	string	索引更新时间。
UpdatePerson	string	索引更新人。
IndexCost	map	cpu_core：索引占用 CPU 核数。 mem_gb：索引占内存大小。

概述

请求参数

示例

请求参数

返回值