查询索引详情
更新时间：2025-04-18
POST
http://{host}/v{version}/index?desc
查询指定索引的详情。
权限说明
鉴权认证机制的详细内容请参见鉴权认证
请求参数
Headers 参数
除公共头域外，无其它特殊头域
URL 参数
version
string
API版本号，当前取1。
必选
host
string
"{实例IP}:{实例Port}"
必选
Body 参数
database
string
指定库的名称。
必选
table
string
指定表的名称。
必选
indexName
string
指定索引的名称。
必选
请求结构
POST /v{version}/index?desc HTTP/1.1
HOST: {Endpoint}
Authorization: {Authorization}
{
"database": "db_name",
"table": "table_name",
"indexName": "vector_idx"
}示例代码
请求示例
curl --location 'http://vdb.nXWNyPCOSLci.vdb.bj.baidubce.com/v1/index?desc' \
--header 'Authorization: Bearer account=root&api_key=eC4bLRy2va******************************' \
--header 'Content-Type: application/json' \
--data '{
"database": "db_test",
"table": "table_test",
"indexName": "vector_idx"
}'返回响应
Headers 参数
除公共头域外，无其它特殊头域
返回参数
msg
string
返回信息
可选
code
integer
返回码
可选
index
object {9}
索引详情信息
可选
显示子属性
隐藏子属性
indexName
string
索引名称。
可选
field
string
索引作用于的字段名称。
可选
fields
array
indexType 为INVERTED时，本字段表明倒排索引作用于的字段名称
可选
显示子属性
隐藏子属性
items
string
indexType
string
索引类型。当前支持如下类型：
可选
metricType
string
向量索引的距离度量算法。支持如下距离类型
注：当使用COSINE距离时，用户需要自行对相关向量进行归一化操作，未经归一化的向量将导致search结果不准确
可选
params
object {6}
向量索引的参数详情。
可选
显示子属性
隐藏子属性
M
integer
HNSW、HNSWPQ索引算法参数，取值范围为[4, 128]。该参数表示每个节点在索引构图中可以连接多少个邻居节点
可选
efConstruction
integer
HNSW、HNSWPQ索引算法参数，取值范围为[8, 1024]。该参数表示搜索时指定寻找节点邻居遍历的范围。数值越大构图效果越好，构图时间也越长。
可选
NSQ
integer
HNSWPQ索引参数，取值范围为[1, dim]。该参数表示量化子空间个数，pq量化相关系数，要求NSQ | dim，NSQ越大量化越精细
可选
sampleRate
float
HNSWPQ索引参数，取值范围为[0.0f, 1.0f]。该参数表示kmeans的采样率，pq抽样总数：10000 + (rowCount - 10000)*sampleRate
可选
fineClusterCount
integer
PUCK索引算法参数，取值范围为[1, 5000]。该参数表示每个粗聚类中心下细聚类中心个数。
可选
coarseClusterCount
string
PUCK索引算法参数，取值范围为[1, 5000]。该参数表示索引中粗聚类中心个数。
可选
autoBuild
boolean
是否自动构建索引。
可选
autoBuildPolicy
object
自动构建索引策略参数
- periodical，周期性构建索引
- rowCountIncrement，根据tablet行增长数自动构建索引
- timing，定时构建索引
可选
显示子属性
隐藏子属性
state
string
索引状态。取值如下：
可选
响应示例
{
"index": {
"indexName": "vector_idx",
"field": "vector_field",
"autoBuild": false,
"indexType": "HNSW",
"metricType": "L2",
"params": {
"M": 32,
"efConstruction": 200
},
"state": "NORMAL"
},
"code": 0,
"msg": "Success"
}