文档中心

向量数据库VikingDB

数据集(Collection)

查看数据集详情-GetVikingdbCollection

概述

接口用于查询指定数据集的详情。

接口升级说明

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

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

请求接口

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

请求参数

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

参数	类型	是否必填	描述
ProjectName	String	否	项目名称
CollectionName	String	2选1	数据集名称
ResourceId	String		数据集资源ID。请求必须指定 ResourceId 和 CollectionName 其中之一，也可同时传递以保证精确定位。资源 ID 可通过相应资源的创建接口返回结果获取，也可在资源详情中查看。

返回参数

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

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

请求示例

action = "GetVikingdbCollection"
body = {
  "ProjectName": "default",
  "CollectionName": "my_test_coll_1"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20250331165532135216135139CD8E48",
    "Action": "GetVikingdbCollection",
    "Version": "2025-06-09",
    "Service": "vikingdb",
    "Region": "cn-beijing"
  },
  "Result": {
    "ProjectName": "default",
    "CollectionName": "my_test_coll_1",
    "Fields": [
      {
        "FieldName": "f_id",
        "FieldType": "string"
      },
      {
        "FieldName": "f_int64",
        "FieldType": "int64",
        "DefaultValue": -1
      },
      {
        "FieldName": "f_string",
        "FieldType": "string",
        "DefaultValue": "DEFAULT_STRING_VALUE"
      },
      {
        "FieldName": "f_vector",
        "FieldType": "vector",
        "Dim": 1024
      }
    ],
    "PrimaryKey": "f_id",
    "Description": "my test collection",
    "CollectionAliases": [
      "current_collection"
    ],
    "CreateTime": "2023-11-21 12:22:57",
    "UpdateTime": "2023-11-22 13:15:45",
    "UpdatePerson": "xiaoming",
    "IndexNames": [
      "idx_1"
    ],
    "IndexCount": 1,
    "CollectionStats": {
      "DataCount": 1500000,
      "DataStorage": 1500000000
    }
  }
}

错误码

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

返回说明补充

FieldType 枚举

值	含义
`string`	字符串标量。
`int64`	64 位整数。
`float32`	单精度浮点数。
`bool`	布尔值。
`list[string]`	字符串数组。
`list[int64]`	64 位整数数组。
`vector`	稠密向量。
`sparse_vector`	稀疏向量。
`text`	供模型向量化或全文检索的文本。
`image`	供多模态模型处理的图片。
`video`	供多模态模型处理的视频。

返回说明补充

Instruction 为 Map，目前包含 AutoFill（Boolean，默认 true）。true 表示按模态自动填充指令；false 表示不自动填充，调用方需要在数据或检索请求中提供适合业务的 Instruction。详细模板参见同版本《Instruction 参数设置》最佳实践。

返回说明补充

FullText 类型为 list<FullTextConfig>。每个元素包含：Field（String，全文检索字段名，必须是已定义的 text 字段）和 Analyzer（Map，解析器配置）；Analyzer.Tokenizer（String）表示分词器，例如 standard。

请求接口补充

请求接口

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

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

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

这个页面对您有帮助吗？

有用

无用

向量数据库VikingDB

请求参数 #

返回参数 #

请求示例 #

返回示例 #

错误码 #

返回说明补充 #

FieldType 枚举 #

返回说明补充 #

返回说明补充 #

请求接口补充 #

请求接口 #

请求参数

返回参数

请求示例

返回示例

错误码

返回说明补充

FieldType 枚举

返回说明补充

返回说明补充

请求接口补充

请求接口