下载文件

下载文件内容。

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

调用前准备

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

下方示例使用:

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

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

  • $FILE_ID:要下载的文件 ID。

请求体

参数

类型

是否必填

说明

file_id

string

文件 ID,不能为空。

volume_id

string

卷 ID。

as_zip

boolean

是否以 ZIP 形式下载。

请求示例

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

成功响应

成功时返回 200 和文件内容。响应体不是 JSON 格式。

文件名可用时,响应头 Content-Disposition 指定附件下载并提供文件名。未提供内容类型时,Content-Typeapplication/octet-stream

响应项

说明

HTTP 状态码

200

Content-Type

文件 MIME 类型;未提供时为 application/octet-stream

Content-Disposition

文件名可用时为附件下载。

响应体

文件内容。

错误响应

下载开始前失败时,返回 JSON 格式的错误信息:

{
  "code": "ErrParamInvalid",
  "msg": "file_id 不能为空",
  "data": null
}

常见 HTTP 错误

HTTP 状态码

错误代码

常见原因

建议操作

400

ErrParamInvalid

file_id 为空或请求体无效。

传入有效的文件 ID。

403

ErrForbidden

当前身份没有所属根卷读取权限。

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

404

ErrNotFound

文件不存在。

检查文件 ID。

500

ErrServer

服务无法打开下载流。

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

后续操作

下载完成后如需继续管理,返回查询 Catalog 详情

最后更新于