查看文件处理链路

从 Catalog 文件查看其关联的工作流处理、其生成的处理结果和处理拓扑。

GET https://api.moi.matrixorigin.cn/v5/lineage/catalog-files/{file_id}/overview

调用前准备

先查看文件产物，仅当响应中的 data.has_artifact 为 true 时再调用本接口。准备有目标工作区访问权限的个人访问令牌、目标工作区 ID 和 Catalog 文件 ID。

file_id 必须是已经由工作流处理并登记了 DataAsset 的 Catalog 文件。仅上传或挂载到 Volume、但尚未经过处理的原始文件不会自动产生处理链路。

路径参数

curl "https://api.moi.matrixorigin.cn/v5/lineage/catalog-files/$FILE_ID/overview" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID"

字段

类型

是否必填

说明

file_id

string

必填

Catalog 文件 ID。

查询参数

文件关联多个 Case 时，传入 case_id 指定要读取的 Case。

curl "https://api.moi.matrixorigin.cn/v5/lineage/catalog-files/$FILE_ID/overview?case_id=$CASE_ID" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID"

字段

类型

是否必填

说明

case_id

string

否

要读取的 Case ID。

成功响应

data 返回文件入口、关联处理结果、工作流调用和处理拓扑。保存其中的 artifact_id 和 node_id；文件名或节点显示名称不能替代这些 ID。

响应字段如下。

{
  "code": "OK",
  "msg": "OK",
  "data": {
    "artifact": {
      "artifact_id": "art-001",
      "root_asset_id": "asset-001",
      "case_id": "case-001",
      "parsed_file_available": true
    },
    "workflow": {
      "workflow_id": "wf-001",
      "workflow_version_id": "ver-001"
    },
    "workflow_invocation": {
      "input": {},
      "vars": {}
    },
    "topology": {
      "nodes": [
        {
          "node_id": "node-001",
          "label": "解析文件"
        }
      ],
      "edges": [],
      "producer_node_id": "node-001"
    },
    "entry": {
      "catalog_file_id": "file-001"
    }
  }
}

字段

类型

是否必填

说明

code

string

否

成功时为 OK。

msg

string

否

成功时为 OK。

下面表格展开响应示例中 data 下的 artifact 对象；每一行是该对象的一个字段。

字段

类型

是否必填

说明

artifact_id

string

否

处理结果 ID。

root_asset_id

string

否

根数据资产 ID。

case_id

string

否

关联案例 ID。

raw_file_id

string

否

原始文件 ID；仅在有值时返回。

parsed_file_id

string

否

解析后的文件 ID；仅在有值时返回。

parsed_file_available

boolean

否

解析后的文件是否可用。

下面表格展开响应示例中 data 下的 workflow 对象；每一行是该对象的一个字段。

字段

类型

是否必填

说明

workflow_id

string

否

工作流 ID；仅在有值时返回。

workflow_version_id

string

否

工作流版本 ID；仅在有值时返回。

下面表格展开响应示例中 data 下的 workflow_invocation 对象；每一行是该对象的一个字段。

字段

类型

是否必填

说明

input

object

否

工作流调用输入；仅在有值时返回。

vars

object

否

工作流调用变量；仅在有值时返回。

下面表格展开响应示例中 data 下的 topology 对象；每一行是该对象的一个字段。

字段

类型

是否必填

说明

nodes

array

否

处理拓扑的节点列表。

edges

array

否

处理拓扑的边列表。

producer_node_id

string

否

生成当前处理结果的节点 ID；仅在有值时返回。

下面表格展开响应示例中 data 下的 entry 对象；每一行是该对象的一个字段。

字段

类型

是否必填

说明

catalog_file_id

string

否

Catalog 文件 ID；仅在有值时返回。

错误响应

{
  "code": "ErrNotFound",
  "msg": "资源不存在",
  "data": null
}

字段

类型

是否必填

说明

code

string

否

错误代码。

msg

string

否

可读错误信息。

data

null

否

错误响应中为 null。

后续操作

查看处理结果链路。

最后更新于