查看数据集列表-ListVikingdbCollection--向量数据库VikingDB-火山引擎

文档中心

立即注册

导航

查看数据集列表-ListVikingdbCollection

最近更新时间：2025.09.30 16:07:17首次发布时间：2025.08.15 11:30:52

概述

接口用于对指定的数据集的列表查询

接口升级说明

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

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

请求接口

说明

请求向量数据库 VikingDB 的 OpenAPI 接口时，可以使用 ak、sk 构造签名进行鉴权。请参见控制面API调用流程，复制调用示例并填入必要信息

请求参数

请求参数Action取值：ListVikingdbCollection
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	子参数	类型	是否必填	描述
ProjectName		String	否	项目名称
PageNumber		Integer	否	翻页页码。起始为1。
PageSize		Integer	否	翻页每页的大小。
Filter		Map	否	过滤条件
Filter	CollectionNameKeyword	String	否	数据集包含的关键词

返回参数

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

参数	一级参数	二级参数	三级参数	类型	描述
TotalCount				Integer	查询结果的总数
PageSize				Integer	请求时的PageSize值，如果请求时未指定，则为默认值。
PageNumber				Integer	请求时的PageNumber值，如果请求时未指定，则为默认值。
Collections				Map	向量库数据集列表
	CollectionName			String	数据集名称
	ResourceId			String	资源ID
	ProjectName			String	项目名称
	Vectorize			Map	向量化配置
		Dense		Map	稠密向量化模型配置
			ModelName	String	模型名称
			ModelVersion	String	模型版本
			TextField	String	文本向量化字段名称
			ImageField	String	图片向量化模型
			Dim	Integer	如果需要生成稠密向量，指定向量维度。默认使用模型默认的维度。
			VideoField	String	视频向量化字段
		Sparse		Map	稀疏向量化配置
			ModelName	String	模型名称
			ModelVersion	String	模型版本
			TextField	String	文本向量化字段名称
	Tags			Map	标签
		Key		String	标签键
		Value		String	标签值
	Description			String	数据集描述
	Fields			Map	字段列表
		FieldName		String	字段名称
		FieldType		String	字段类型
		Dim		Integer	若字段类型是vector，该参数指定稠密向量的维度
		IsPrimaryKey		Boolean	是否为主键字段。可以为数据集指定1个主键字段（string或int64类型）。若没有指定，则使用自动生成的主键，字段名为"AUTO_ID"。
		DefaultValue		任意类型	字段内容默认值
	CreateTime			Map	创建时间
	UpdateTime			Map	更新时间
	UpdatePerson			Map	更新人
	CollectionStats			Map	统计信息
		DataCount		Long	数据条数
		DataStorage		Long	数据存储量(byte)
	EnableKeywordsSearch			Boolean	是否支持关键词检索
	IndexNames			Array of String	数据集下的索引名称列表
	IndexCount			Integer	数据集下的索引个数

请求示例

action = "ListVikingdbCollection"
body = {
  "PageNumber": 1,
  "PageSize": 10,
  "Filter": {
    "CollectionNameKeyword": "test"
  }
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202504151652000192410360866607FF",
    "Action": "ListVikingdbCollection",
    "Version": "2025-06-09",
    "Service": "vikingdb",
    "Region": "cn-beijing"
  },
  "Result": {
    "Collections": [
      {
        "CollectionName": "test_coll",
        "ResourceId": "vdb-abcabc",
        "ProjectName": "default",
        "Description": "",
        "Fields": [
          {
            "FieldName": "f_v",
            "FieldType": "vector",
            "Dim": 1024
          },
          {
            "FieldName": "f_s",
            "FieldType": "string"
          }
        ],
        "CreateTime": "2023-11-21 12:22:57",
        "UpdateTime": "2023-11-22 13:15:45",
        "UpdatePersion": "xiaoming",
        "CollectionStats": {
          "DataCount": 887,
          "DataStorage": 475000
        },
        "IndexCount": 1,
        "IndexNames": [
          "idx1"
        ]
      }
    ]
  }
}

错误码

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