更新数据集-UpdateVikingdbCollection--向量数据库VikingDB-火山引擎

文档中心

立即注册

导航

向量数据库VikingDB

更新数据集-UpdateVikingdbCollection

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

概述

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

接口升级说明

对应的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	2选1	数据集资源ID。请求必须指定ResourceId和CollectionName其中之一。
Description		Map	否	数据集描述
Fields		List	是	字段列表
	FieldName	String	是	字段名称
	FieldType	String	是	字段类型
	DefaultValue	任意类型	否	字段内容默认值

返回参数

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

参数	类型	示例值	描述
Message	Map	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"
  }
}

错误码

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