查看数据资产¶
按原始文件 ID 查询其处理后对应的数据资产。
GET https://api.moi.matrixorigin.cn/v5/catalog/files/{file_id}/data-asset
调用前准备¶
先查询文件列表取得原始文件 ID。准备有目标工作区访问权限的个人访问令牌、目标工作区 ID 和文件 ID。
请求参数¶
curl "https://api.moi.matrixorigin.cn/v5/catalog/files/$FILE_ID/data-asset" \
-H "X-API-Key: $AI_STUDIO_API_KEY" \
-H "X-Workspace-ID: $WORKSPACE_ID"
字段 |
类型 |
必填 |
说明 |
|---|---|---|---|
|
string |
否 |
原始文件 ID。 |
成功响应¶
成功时返回 200 和数据资产信息。文件尚未处理为数据资产时返回 404,接口不会自动创建数据资产。
{
"code": "OK",
"msg": "OK",
"data": {
"asset": {
"id": 1,
"asset_id": "asset-123",
"name": "orders.csv",
"volume_id": 789,
"asset_type": "file",
"asset_ref": "file-123"
},
"derivations": [],
"assets_by_id": {}
}
}
字段 |
类型 |
说明 |
|---|---|---|
|
string |
成功时为 |
|
string |
成功时为 |
下面表格展开响应示例中 data 对象;每一行是该对象的一个字段。
字段 |
类型 |
说明 |
|---|---|---|
|
object |
与原始文件对应的数据资产。 |
|
array |
资产派生关系。 |
|
object |
原始文件与解析产物的映射元数据;没有时可能省略。 |
|
object |
按资产 ID 索引的相关资产。对象键由服务端返回的资产 ID 决定,无法预先枚举;每个值均为本页 |
下面表格展开响应示例中 data.asset 对象;每一行是该对象的一个字段。
字段 |
类型 |
说明 |
|---|---|---|
|
integer |
数据资产内部 ID。 |
|
string |
数据资产 ID。 |
|
string |
资产名称。 |
|
string |
兼容字段,旧的原始文件 ID;适用时返回。 |
|
integer |
所属卷 ID。 |
|
string |
数据资产类型。 |
|
string |
数据资产引用标识。 |
|
string |
数据资产来源。 |
|
object |
数据资产扩展元数据。键由处理链路写入,服务端未定义固定键集。 |
|
integer |
创建时间的 Unix 时间戳(秒)。 |
|
integer |
更新时间的 Unix 时间戳(秒)。 |
下面表格展开响应示例中 data.derivations 数组的每一项;每一行是该数组项的一个字段。
字段 |
类型 |
说明 |
|---|---|---|
|
integer |
派生关系内部 ID。 |
|
string |
兼容字段,旧的源资产 ID;适用时返回。 |
|
string |
派生关系类型。 |
|
string |
兼容字段,旧的目标物理引用;适用时返回。 |
|
object |
派生关系扩展元数据。键由处理链路写入,服务端未定义固定键集。 |
|
integer |
创建时间的 Unix 时间戳(秒)。 |
|
integer |
更新时间的 Unix 时间戳(秒)。 |
|
string |
根数据资产 ID。 |
|
string |
源数据资产 ID。 |
|
string |
目标数据资产 ID。 |
|
string |
关联案例 ID;适用时返回。 |
|
string |
产出该关系的工作项 ID;适用时返回。 |
|
string |
记录该关系的工作项 ID;适用时返回。 |
|
integer |
并行处理序号;适用时返回。 |
|
string |
逻辑槽位;适用时返回。 |
|
string |
幂等键;适用时返回。 |
下面表格展开响应示例中 data.manifest 对象;每一行是该对象的一个字段。
字段 |
类型 |
说明 |
|---|---|---|
|
integer |
映射元数据内部 ID。 |
|
string |
兼容字段,旧的根资产 ID;适用时返回。 |
|
string |
兼容字段,旧的源文件 ID;适用时返回。 |
|
string |
解析产物文件 ID。 |
|
object |
解析清单扩展内容。键由处理链路写入,服务端未定义固定键集。 |
|
integer |
创建时间的 Unix 时间戳(秒)。 |
|
integer |
更新时间的 Unix 时间戳(秒)。 |
|
string |
根数据资产 ID。 |
|
string |
源文件 ID。 |
|
string |
解析数据资产 ID。 |
错误响应¶
{
"code": "ErrNotFound",
"msg": "对象不存在",
"data": null
}
字段 |
类型 |
说明 |
|---|---|---|
|
string |
错误代码。 |
|
string |
错误信息。 |
|
null |
错误响应中的附加数据;本示例为 |