查询工作流派发作业详情¶
查询工作流批量文件派发作业的当前状态和文件投递计数。data.dispatch_job.status 变为 completed 仅表示批次文件投递处理已结束,不表示各文件触发的工作流作业已执行完成;请继续查询工作流作业列表跟踪单个作业的执行状态。
GET https://api.moi.matrixorigin.cn/v5/workflow/v2/workflow-apps/{workflow_id}/dispatch-jobs/{dispatch_job_id}
调用前准备¶
请求参数¶
将 $AI_STUDIO_API_KEY、$WORKSPACE_ID、$WORKFLOW_ID 和 $DISPATCH_JOB_ID 替换为实际值。
curl "https://api.moi.matrixorigin.cn/v5/workflow/v2/workflow-apps/$WORKFLOW_ID/dispatch-jobs/$DISPATCH_JOB_ID" \
-H "X-API-Key: $AI_STUDIO_API_KEY" \
-H "X-Workspace-ID: $WORKSPACE_ID"
路径参数
参数 |
类型 |
是否必填 |
说明 |
|---|---|---|---|
|
string |
是 |
派发作业所属的工作流 ID。派发作业不属于该工作流或当前工作区时返回 |
|
string |
是 |
派发作业 ID。可从批量文件启动响应的 |
成功响应¶
{
"code": "OK",
"msg": "OK",
"data": {
"dispatch_job": {
"dispatch_job_id": "dispatch-001",
"workflow_id": "wf-001",
"status": "completed",
"total_deliveries": 12,
"pending_deliveries": 0,
"failed_deliveries": 1
}
}
}
字段 |
类型 |
说明 |
|---|---|---|
|
string |
请求处理成功时为 |
|
string |
请求处理的说明文本。 |
|
object |
本次操作返回的数据。 |
|
object |
派发作业状态与投递统计。 |
|
string |
派发作业 ID。 |
|
string |
所属工作流 ID。 |
|
string |
派发作业状态。取值为 |
|
integer |
本次派发作业创建的文件投递总数。 |
|
integer |
仍在等待派发、派发中或等待重试的投递条目数。 |
|
integer |
重试耗尽后投递失败的条目数。 |
错误响应¶
目标工作流或派发作业不存在、派发作业不属于指定工作流,或当前凭据无权读取目标工作流时返回错误。核对工作区 ID、工作流 ID 与派发作业 ID 后重试。
{
"code": "ErrNotFound",
"msg": "Not Found"
}
字段 |
类型 |
说明 |
|---|---|---|
|
string |
错误代码。 |
|
string |
可读错误信息。 |
常见 HTTP 错误¶
HTTP 状态码 |
错误代码 |
常见原因 |
建议操作 |
|---|---|---|---|
400 |
|
缺少目标工作区或路径参数无效。 |
检查工作区请求头和路径中的工作流 ID。 |
401 |
|
认证凭据缺失或已失效。 |
检查个人访问令牌是否有效。 |
403 |
|
当前身份无权查看目标工作流的派发作业。 |
使用具备工作流读取权限的身份,或联系管理员授权。 |
404 |
|
工作流不存在、未激活,或派发作业不属于当前工作区与指定工作流。 |
核对 |
500 |
|
服务端读取派发记录失败或持久化派发状态异常。 |
保留请求标识,稍后核对派发状态。 |
503 |
|
授权或存储依赖暂不可用。 |
稍后重试查询。 |