rm-删除资源--向量数据库VikingDB-火山引擎

文档中心

向量数据库VikingDB

请输入

文件系统操作

rm-删除资源

概述

/api/v1/fs 接口用于删除 OpenViking 文件系统中的文件或目录。rm 是幂等操作：删除一个合法但不存在的 URI 仍会成功。URI 格式非法、scheme 不支持或使用非公开作用域时返回 INVALID_URI。

前置条件

完成 API 鉴权说明页面的 API Key 获取后，可调用本接口删除资源。

请求接口

URI	/api/v1/fs	统一资源标识符
请求方法	DELETE	客户端请求类型
请求头	Authorization: Bearer	Bearer Token 鉴权

请求参数

参数	类型	必选	默认值	备注
uri	string	是	--	要删除的 Viking URI 指定需要删除的文件或目录 URI。删除一个合法但不存在的 URI 仍会成功（幂等操作）。
recursive	bool	否	false	递归删除为 `true` 时递归删除目录及其所有子内容。删除目录时建议设置为 `true`，否则仅删除空目录。

响应消息

字段	参数说明
status	请求状态，成功为 `"ok"`，失败为 `"error"`
result	成功时返回的数据对象
result.uri	被删除资源的 URI
telemetry	遥测信息，通常为 `null`
error	失败时返回的错误对象
error.code	错误码字符串，常见值见下表
error.message	可读的错误描述

常见错误码：

error.code	说明
UNAUTHENTICATED	缺少或无效的 API Key
PERMISSION_DENIED	权限不足
INVALID_URI	URI 格式非法、scheme 不支持或使用非公开作用域

完整示例

示例一：删除单个文件

curl -X DELETE "https://xxx/api/v1/fs?uri=viking://resources/docs/old.md" \
  -H "X-Api-Key: your-api-key"

执行成功返回：

HTTP/1.1 200 OK
Content-Type: application/json

{
    "status": "ok",
    "result": {
        "uri": "viking://resources/docs/old.md"
    },
    "error": null,
    "telemetry": null
}

示例二：递归删除目录

curl -X DELETE "https://xxx/api/v1/fs?uri=viking://resources/old-project/&recursive=true" \
  -H "X-Api-Key: your-api-key"

执行成功返回：

{
    "status": "ok",
    "result": {
        "uri": "viking://resources/old-project/"
    },
    "error": null,
    "telemetry": null
}

最近更新时间：2026.05.26 11:19:27

这个页面对您有帮助吗？

有用

无用

向量数据库VikingDB

示例一：删除单个文件 #

示例二：递归删除目录 #

示例一：删除单个文件

示例二：递归删除目录