文档中心

向量数据库VikingDB

请输入

数据集(Collection)

更新数据集-UpdateVikingdbCollection

概述

接口用于更新指定的数据集。

接口升级说明

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

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

请求接口

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

请求参数

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

参数	子参数	类型	是否必填	描述
ProjectName		String	否	项目名称
CollectionName		String	2选1	数据集名称
ResourceId		String		数据集资源ID。请求必须指定ResourceId和CollectionName其中之一。资源 ID 可通过相应资源的创建接口返回结果获取，也可在资源详情中查看。
Description		Map	否	数据集描述
Fields		List	是	字段列表更新操作只用于新增字段，不能修改或删除已有的字段。支持新增 `string`、`int64`、`float32`、`bool`、`list<string>`、`list<int64>`、`text`、`date_time`、`geo_point`、`list<geo_point>` 字段；不支持新增 `vector`、`sparse_vector`、`tensor`、`image`、`video` 字段。
	FieldName	String	是	字段名称
	FieldType	String	是	字段类型
	DefaultValue	任意类型	否	字段默认值。省略时 int64、float32、string、bool、list<int64>、list<string>、text、date_time、geo_point、list<geo_point> 分别使用 `0`、`0.0`、`"default"`、`false`、`[0]`、`["default"]`、空字符串、`1970-01-01T00:00:00Z`、`"0, 0"`、空列表。

返回参数

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

参数	类型	示例值	描述
Message	String	success	操作结果信息

请求示例

action = "UpdateVikingdbCollection",
body = {
    "ProjectName": "default",
    "CollectionName": "my_test_coll_1",
    "Fields": [
        {
            "FieldName": "float_1",
            "FieldType": "float32",
            "DefaultValue": 0.0,
        },
    ]
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20250331204547113075129206F7CB23",
    "Action": "UpdateVikingdbCollection",
    "Version": "2025-06-09",
    "Service": "vikingdb",
    "Region": "cn-beijing"
  },
  "Result": {
    "Message": "success"
  }
}

错误码

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

参数说明补充

FieldType 枚举

值	含义
`string`	字符串标量。
`int64`	64 位整数。
`float32`	单精度浮点数。
`bool`	布尔值。
`list[string]`	字符串数组。
`list[int64]`	64 位整数数组。
`text`	供模型向量化或全文检索的文本。
`date_time`	日期时间。
`geo_point`	单个地理坐标点。
`list<geo_point>`	地理坐标点数组。

更新接口不支持新增 vector、sparse_vector、tensor、image、video 字段。

请求接口补充

请求接口

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

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

参数说明补充

FieldName 必须以英文字母开头，可包含英文字母、数字、下划线和点号，不能以点号结尾，长度不超过 128 Byte；同一 Collection 内字段名不可重复。

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

这个页面对您有帮助吗？

有用

无用

向量数据库VikingDB

请求参数 #

返回参数 #

请求示例 #

返回示例 #

错误码 #

参数说明补充 #

FieldType 枚举 #

请求接口补充 #

请求接口 #

参数说明补充 #

请求参数

返回参数

请求示例

返回示例

错误码

参数说明补充

FieldType 枚举

请求接口补充

请求接口

参数说明补充