解除文件引用

解除一组文件的引用。所有文件必须属于同一个根卷。

POST https://moi.matrixorigin.cn/newmoi/catalog/file/delete_ref

调用前准备

查询文件列表取得要解除引用的文件 ID。准备有目标工作区访问权限的个人访问令牌、目标工作区 ID 和文件 ID。

下方示例使用:

  • $AI_STUDIO_API_KEY:实际个人访问令牌,通过 X-API-Key Header 传递。

  • $WORKSPACE_ID:目标工作区 ID,通过 X-Workspace-ID Header 传递。

  • $FILE_ID:要解除引用的文件 ID。

所有文件必须属于同一个根卷。

请求体

参数

类型

是否必填

说明

file_ids

array[string]

要解除引用的一个或多个文件 ID。

volume_id

integer

声明时必须与解析出的根卷一致。

请求示例

curl -X POST "https://moi.matrixorigin.cn/newmoi/catalog/file/delete_ref" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -H 'Content-Type: application/json' \
  -d '{
    "file_ids": ["'"$FILE_ID"'"]
  }'

成功响应

成功时返回 200datanull。该操作解除文件与卷的关联,不表示删除文件本体。

{
  "code": "OK",
  "msg": "OK",
  "data": null
}

响应字段如下。

字段

类型

说明

code

string

成功时为 OK

msg

string

成功时为 OK

data

null

解除关联成功时固定为 null

错误响应

{
  "code": "ErrParamInvalid",
  "msg": "文件必须属于同一根卷",
  "data": null
}

常见 HTTP 错误

HTTP 状态码

错误代码

常见原因

建议操作

400

ErrParamInvalid

file_ids 为空、包含无效 ID、与 volume_id 冲突,或文件不属于同一根卷。

传入同一根卷中的有效文件 ID。

403

ErrForbidden

当前身份没有根卷写入权限。

使用有写入权限的凭据,或联系管理员授权。

404

ErrNotFound

某个文件不存在。

检查全部文件 ID。

409

ErrReadonly

目标卷不可写。

选择可写卷。

500

ErrServer

服务无法解除文件关联。

记录请求时间和错误信息后重试;持续失败时联系支持人员。

后续操作

完成后查询 Catalog 详情确认结果。

最后更新于