文档中心

向量数据库VikingDB

索引(Index)

查看索引列表-ListVikingdbIndex

概述

接口用于查看指定索引列表。

接口升级说明

对应的V1接口为：https://www.volcengine.com/docs/84313/1254558
使用区别：

	V2接口	V1接口
参数命名风格	驼峰（`IndexName`）	下划线（`index_name`）

注：QPS 限流是以数据条数计算，V1 与 V2 接口的限流行为完全相同。

请求接口

请求向量数据库 VikingDB 的 OpenAPI 接口时，可以使用 ak、sk 或构造签名进行鉴权。

请求参数

请求参数 Action 取值：ListVikingdbIndex。

参数	一级子参数	类型	是否必填	描述
PageNumber		Integer	否	翻页页码。起始为1。
PageSize		Integer	否	翻页每页的大小。
Filter		Map	否	过滤条件
	IndexNameKeyword	String	否	索引名称包含的关键词
	Status	Array of String	否	索引状态过滤条件。可选值：`READY`、`FAILED`、`INIT`、`CHANGING`、`DELETING`、`DISABLED`、`DISABLING`。不传时不过滤状态。
	CollectionName	Array of String	否	数据集名称

Status 支持传入一个或多个状态值，服务端按状态过滤返回结果。状态值大小写不敏感，服务端会统一转为大写处理。

状态	含义
`READY`	索引已就绪，可用于检索。
`FAILED`	索引创建、更新或构建失败。
`INIT`	索引初始化中。
`CHANGING`	索引配置变更中。
`DELETING`	索引删除中。
`DISABLED`	索引已禁用。
`DISABLING`	索引禁用中。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	一级子参数	二级子参数	类型	描述
Indexes			Array of Map	向量库索引详情列表
	CollectionName		String	数据集名称
	ProjectName		String	项目名称
	ResourceId		String	资源ID
	IndexName		String	索引名称
	Description		String	索引的自定义描述。
	VectorIndex		Map	向量索引配置
		IndexType	String	索引类型
		Distance	String	距离类型，衡量向量之间距离的算法。取值如下： ip：全称是 Inner Product，内积，该算法基于向量的内积，即两个元素的对应元素相乘并求和的结果计算相似度，内积值越大相似度越高。 l2：欧几里得距离，它计算两个向量的欧几里得空间距离，欧式距离越小相似度越高。 cosine：余弦相似度（Cosine Similarity），也称为余弦距离（Cosine Distance），用于计算两个高维向量的夹角余弦值从而衡量向量相似度，夹角余弦值越小表示两向量的夹角越大，则两个向量差异越大。当 distance=cosine 时，默认对向量做归一化处理。当索引算法选择IVF时，距离类型可选ip、cosine。对于hnsw_hybrid索引算法，距离类型选择只对稠密向量生效，稀疏向量仅支持内积。
		Quant	String	量化方式。量化方式是索引中对向量的压缩方式，可以降低向量间相似性计算的复杂度。基于向量的高维度和大规模特点，采用向量量化可以有效减少向量的存储和计算成本。取值如下： int8：将4字节的 float 压缩为单个字节，以获取内存和计算延迟的收益，会造成微小的损失精度，比如 cosine 距离会出现大于1的分值。 float：全精度，未做压缩量化。 fix16：将4字节的 float 压缩为两个字节，以获取内存和计算延迟的收益，会造成微小的损失精度。通过损失一定的检索精度，提升检索性能，节约资源成本。 pq：将高维向量转换为低维码本向量，以减少内存占用并提高搜索效率。 int8适用于hnsw、hnsw_hybrid、flat索引算法，距离方式为ip、cosine。 float适用于hnsw、hnsw_hybrid、flat、diskann索引算法，距离方式为ip、l2、cosine。 fix16适用于hnsw、hnsw_hybrid、flat索引算法，距离方式为ip、l2、cosine。 pq适用于diskann、ivf索引算法，距离方式为ip、l2、cosine。
		HnswM	Integer	hnsw 索引参数，表示邻居节点个数。当 index_type 配置为 hnsw 和 hnsw_hybrid 时可选配置。
		HnswCef	Integer	hnsw 索引参数，表示构建图时搜索邻居节点的广度。当 index_type 配置为 hnsw 和 hnsw_hybrid 时可选配置。
		HnswSef	Integer	hnsw 索引参数，表示线上检索的搜索广度。当 index_type 配置为 hnsw 和 hnsw_hybrid 时可选配置。
		DiskannM	Integer	diskann 参数，表示邻居节点个数。当 index_type 配置为 diskann 时可选配置。
		DiskannCef	Integer	diskann 参数，表示构建图时搜索邻居节点的广度。当 index_type 配置为 diskann 时可选配置。
		PqCodeRatio	Float	diskann 参数，向量维度编码的大小限制。值越大，召回率越高，但会增加内存使用量，范围 (0.0, 0.25]。当 index_type 配置为 diskann 时可选配置。
		CacheRatio	Float	diskann 参数，缓存节点数与原始数据的比率，较大的值会提高索引性能并增加内存使用量。范围 [0.0,0.3)。当 index_type 配置为 diskann 时可选配置。
	ScalarIndex		Array of Map	标量字段列表 `JSON <br> { <br> "ScalarIndex": [ <br> { <br> "FieldName": "f_int64_1", <br> "FieldType": "int64", <br> "DefaultValue": 0 <br> } <br> ] <br> } <br>`
	CpuQuota		Integer	索引检索消耗的 CPU 配额。
	ShardPolicy		String	索引分片类型，auto为自动分片、custom为自定义分片。
	ShardCount		Integer	索引分片数
	ActualCU		Integer	实际CU用量
	Status		String	索引状态：`INIT`（初始化）、`READY`（可用）、`FAILED`（失败）、`CHANGING`（变更中）、`DISABLING`（停用中）、`DISABLED`（已停用）、`DELETING`（删除中）。
PageSize			Integer	请求时的PageSize值，如果请求时未指定，则为默认值。
PageNumber			Integer	请求时的PageNumber值，如果请求时未指定，则为默认值。
TotalCount			Integer	查询结果的总数

请求示例

action = "ListVikingdbIndex",
body = {
  "PageNumber": 1,
  "PageSize": 10,
  "Filter": {
    "CollectionName": ["test_collection"],
    "Status": ["READY"],
    "IndexNameKeyword": "idx"
  },
  "ProjectName": "default"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202506091046060340120112242B5E18",
    "Action": "ListVikingdbIndex",
    "Version": "2025-06-09",
    "Service": "vikingdb",
    "Region": "cn-beijing"
  },
  "Result": {
    "Indexes": [
      {
        "ProjectName": "w",
        "ResourceId": "vdb-abcabcabc",
        "CollectionName": "test_collection",
        "IndexName": "idx_1",
        "Description": "",
        "VectorIndex": {
          "IndexType": "hnsw",
          "Distance": "ip",
          "Quant": "int8",
          "HnswM": 20,
          "HnswCef": 400,
          "HnswSef": 400
        },
        "ScalarIndex": [
             {    
                 "FieldName": "f_int64_1",
                 "FieldType": "int64",
                 "DefaultValue": 0
             },
             {
                 "FieldName": "f_string_1",
                 "FieldType": "string",
                 "DefaultValue": "default"
             }
        ],
        "CpuQuota": 1,
        "ShardPolicy": "auto",
        "ShardCount": 1,
        "IndexCost": {
          "CpuCore": 1,
          "MemGb": 1
        }
      }
    ],
    "PageSize": 10,
    "PageNumber": 1,
    "TotalCount": 1
  }
}

错误码

错误码请参见公共错误码文档。

参数说明补充

PageSize 不传时默认值为 10。

参数说明补充

PageSize 支持范围为 [1, 100]，默认值为 10；超过范围会返回参数错误。

返回说明补充

IndexType 可选值：hnsw（图索引，适合低时延近邻检索）、hnsw_hybrid（稠密/稀疏混合图索引）、flat（精确暴力检索）和 diskann（面向大规模数据的磁盘近邻索引）。

请求接口补充

请求接口

HTTP 方法：POST
请求路径：/
Host：vikingdb.<region>.volcengineapi.com
Query：Action=ListVikingdbIndex&Version=2025-06-09

请求体使用本页参数表所列 JSON 结构；<region> 替换为实例所在地域。

返回说明补充

IndexCost 类型为 Map，表示索引资源成本；IndexCost.CpuCore 为 Integer，单位 CPU Core；IndexCost.MemGb 为 Integer，单位 GiB。

最近更新时间：2026.09.08 12:02:51

这个页面对您有帮助吗？

有用

无用

向量数据库VikingDB

请求参数 #

返回参数 #

请求示例 #

返回示例 #

错误码 #

参数说明补充 #

参数说明补充 #

返回说明补充 #

请求接口补充 #

请求接口 #

返回说明补充 #

请求参数

返回参数

请求示例

返回示例

错误码

参数说明补充

参数说明补充

返回说明补充

请求接口补充

请求接口

返回说明补充