查询文件产物

按文件 ID 查询文件产物信息。

GET https://moi.matrixorigin.cn/newmoi/catalog/file-artifacts/{file_id}

调用前准备

查询文件列表取得目标文件 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。

请求示例

curl "https://moi.matrixorigin.cn/newmoi/catalog/file-artifacts/$FILE_ID" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID"

成功响应

成功时返回 200 和文件产物信息;文件不存在时返回 404

{
  "code": "OK",
  "msg": "OK",
  "data": {
    "file_id": "file-123",
    "file_exists": true,
    "has_artifact": false,
    "derivations": [],
    "assets_by_id": {}
  }
}

响应字段如下。

字段

类型

说明

code

string

成功时为 OK

msg

string

成功时为 OK

data.file_id

string

查询的文件 ID。

data.file_exists

boolean

文件是否存在。

data.has_artifact

boolean

文件是否存在关联产物。

data.source_file_id

string

源文件 ID;没有时可能省略。

data.parsed_file_id

string

解析产物文件 ID;没有时可能省略。

data.root_asset

object

根数据资产;没有时可能省略。

data.stage_asset

object

处理中数据资产;没有时可能省略。

data.parsed_asset

object

解析后的数据资产;没有时可能省略。

data.derivations

array

数据资产派生关系。

data.manifest

object

原始文件与解析产物的映射元数据;没有时可能省略。

data.assets_by_id

object

按资产 ID 索引的相关资产。

错误响应

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

常见 HTTP 错误

HTTP 状态码

错误代码

常见原因

建议操作

400

ErrParamInvalid

路径中的 file_id 缺失或无效。

传入有效的文件 ID。

403

ErrForbidden

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

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

404

ErrNotFound

文件不存在。

检查文件 ID。

500

ErrServer

服务无法读取文件产物。

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

后续操作

保存目标项的标识,再查询 Catalog 详情

最后更新于