查看工作流作业结果¶
查看一个工作流作业的执行结果和节点状态。作业尚未完成时,返回当前已产生的信息。
GET https://api.moi.matrixorigin.cn/v5/workflow/v2/workflow-apps/{workflow_id}/executions/{execution_id}/result
调用前准备¶
先启动工作流作业或查看工作流作业列表,取得工作流 ID 和作业 ID。准备具有工作流读取权限的个人访问令牌和目标工作区 ID。
路径参数¶
将 $AI_STUDIO_API_KEY、$WORKSPACE_ID、$WORKFLOW_ID 和 $EXECUTION_ID 替换为实际值。
curl "https://api.moi.matrixorigin.cn/v5/workflow/v2/workflow-apps/$WORKFLOW_ID/executions/$EXECUTION_ID/result" \
-H "X-API-Key: $AI_STUDIO_API_KEY" \
-H "X-Workspace-ID: $WORKSPACE_ID"
参数 |
类型 |
是否必填 |
说明 |
|---|---|---|---|
|
string |
是 |
工作流 ID。 |
|
string |
是 |
作业 ID。 |
成功响应¶
成功时返回 200 和当前已产生的结果。
{
"code": "OK",
"msg": "OK",
"data": {
"result": {
"execution_id": "run-001",
"workflow_id": "wf-001",
"status": "completed",
"node_states": [
{
"node_key": "extract",
"status": "COMPLETED"
}
]
}
}
}
下面表格展开响应示例中 data 下的 result 对象;每一行是该对象的一个字段。
字段 |
类型 |
说明 |
|---|---|---|
|
string |
作业 ID。 |
|
string |
工作流 ID。 |
|
string |
服务端任务标识;有值时返回。 |
|
string |
服务端案例标识;有值时返回。 |
|
string |
当前或最终执行状态。 |
|
string |
服务端提供的执行结果;有值时返回。 |
|
string |
服务端提供的执行错误;有值时返回。 |
|
object |
重新运行上下文;有值时返回。 |
|
object |
追踪数据;有值时返回。 |
|
string |
获取追踪数据时的错误;有值时返回。 |
|
array of object |
节点追踪状态列表。 |
|
array of string |
当前状态下允许的操作。 |
|
object |
作业摘要;有值时返回。 |
下面表格展开 node_states 列表的一项;每一行是一个节点状态字段。
字段 |
类型 |
说明 |
|---|---|---|
|
string |
节点追踪片段 ID。 |
|
string |
父追踪片段 ID;有值时返回。 |
|
string |
节点 ID;有值时返回。 |
|
string |
节点追踪名称。 |
|
string |
节点键;服务端提供时返回。 |
|
string |
工作项 ID;有值时返回。 |
|
string |
执行该节点的 Worker ID;有值时返回。 |
|
string |
节点类型;有值时返回。 |
|
string |
节点执行状态。 |
|
string |
节点错误;执行失败时返回。 |
|
string |
节点开始时间;有值时返回。 |
|
string |
节点结束时间;有值时返回。 |
|
integer |
节点执行耗时,单位为毫秒;有值时返回。 |
|
string |
追踪属性的 JSON 文本;有值时返回。 |
错误响应¶
{
"code": "ErrNotFound",
"msg": "未找到工作流作业",
"data": null
}
字段 |
类型 |
说明 |
|---|---|---|
|
string |
错误代码。 |
|
string |
可读错误信息。 |
|
null |
错误响应中为 |