删除文件

删除指定文件。

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

调用前准备

查询文件列表取得目标文件 ID 和所属卷 ID。准备有目标工作区访问权限的个人访问令牌、目标工作区 ID、文件 ID 和卷 ID。

下方示例使用:

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

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

  • $FILE_ID:要删除的文件 ID。

  • $VOLUME_ID:文件所属卷 ID。

此操作会移除文件关联并删除文件,且不可恢复。

请求体

参数

类型

是否必填

说明

id

string

文件 ID。

volume_id

string

文件所属卷 ID。

请求示例

curl -X POST "https://moi.matrixorigin.cn/newmoi/catalog/file/delete" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -H 'Content-Type: application/json' \
  -d '{
    "id": "'"$FILE_ID"'",
    "volume_id": "'"$VOLUME_ID"'"
  }'

成功响应

成功时返回 200datanull。该操作会移除文件关联并删除文件,且不可恢复。

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

响应字段如下。

字段

类型

说明

code

string

成功时为 OK

msg

string

成功时为 OK

data

null

删除成功时固定为 null

错误响应

{
  "code": "ErrNotFound",
  "msg": "对象不存在",
  "data": null
}

常见 HTTP 错误

HTTP 状态码

错误代码

常见原因

建议操作

400

ErrParamInvalid

idvolume_id 缺失或无效。

检查文件 ID 和所属卷 ID。

403

ErrForbidden

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

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

404

ErrNotFound

文件或所属卷不存在。

检查文件 ID 和卷 ID。

409

ErrReadonly

文件所在卷不可写。

选择可写卷中的文件。

500

ErrServer

服务无法删除文件。

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

后续操作

查询文件产物,确认目标已不再出现。

最后更新于