Skip to main content
Files

删除 File

删除没有受保护引用的 File。

路径

DELETE /api/v1/forward/files/{file_id}

请求头

头部必选说明
Authorization是Bearer <PAT 或 SAT>
删除前会检查引用关系。未归档的 Schedule(包括已暂停的 Schedule)引用该文件时返回 HTTP 409;更新或清空 Schedule 文件配置、归档 Schedule 可以释放该配置引用。尚未结束的 Schedule Run 已选定的文件仍受保护,直到 Run 进入终态。详见 Schedule 文件删除限制。 其他 Template / Identity Config 或 Session 的引用也可能继续阻止删除。没有阻止删除的引用时删除 File;删除后不再出现在默认列表中。

路径参数

参数类型必选说明
file_idstring是要删除的 File ID。

查询参数

参数类型必选说明
identity_idstring否仅在操作 Identity 归属资源时使用;PAT 可通过 Query 显式传入,不传时为管理员视角;SAT 由凭证确定归属,任何 SAT 显式携带该参数(包括空值)返回 HTTP 400。详见 Identity 归属。

示例请求

curl -X DELETE "https://api.qoder.com/api/v1/forward/files/file_xxx" \
  -H "Authorization: Bearer $QODER_ACCESS_TOKEN"

示例响应

{
  "id": "file_xxx",
  "type": "file_deleted",
  "deleted": true
}

响应字段解释

字段类型说明
idstring被删除资源的 ID。
typestring删除结果类型。
deletedboolean是否已删除。

错误码

HTTPtype触发条件
400invalid_request_error请求体、路径参数或查询参数非法;包括 SAT 显式携带 Query identity_id(含空值)。
401authentication_error缺少或无效的认证令牌。
403permission_error管理员 Scope 发生 Owner mismatch,或下游服务拒绝访问。
404not_found_errorFile 不存在、未注册或在当前 Identity Scope 不可见;PAT 指定的 Identity 无效、已禁用、已删除或越权。
409conflict_error幂等键冲突、创建恢复需要人工介入,或仍被 Template / Identity Config、未归档 Schedule、未结束的 Schedule Run 或 Session 引用。
429rate_limit_error上传容量不足。
500/502/503api_errorForward 或依赖服务失败。