GetWorkflowInstance - 获取工作流实例详情及DAG
获取指定工作流实例的详情，包含实例状态，依赖关系，每个任务实例的状态等。专业版应用才支持。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
edas:ReadSchedulerxWorkflowQuery |
get |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| RegionId |
string |
是 |
地域 ID |
cn-hangzhou |
| Namespace |
string |
是 |
命名空间 ID，在控制台的命名空间页面中获取 |
adcfc35d-e2fe-4fe9-bbaa-20e90ffc**** |
| NamespaceSource |
string |
否 |
特殊第三方才需要填写 |
schedulerx |
| GroupId |
string |
是 |
应用分组 ID，在控制台的应用管理页面中获取 |
testSchedulerx.defaultGroup |
| WorkflowId |
integer |
是 |
工作流 ID |
123 |
| WfInstanceId |
integer |
是 |
工作流实例 ID |
123456 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| RequestId |
string |
请求唯一 ID |
39090022-1F3B-4797-8518-6B61095F1AF0 |
| Code |
integer |
返回码 |
200 |
| Success |
boolean |
API 执行是否成功。取值如下：
|
true |
| Message |
string |
错误信息 |
workflowId=xxx is not existed |
| Data |
object |
工作流实例详情封装在 data 中 |
|
| WfInstanceInfo |
object |
工作流实例详情，包含了工作流的状态，开始结束时间，各个任务实例的状态及依赖关系 |
|
| Status |
integer |
工作流实例状态，取值如下：
|
5 |
| StartTime |
string |
开始时间，格式为 yyyy-MM-dd HH:mm:ss。 |
2023-01-03 18:00:01 |
| EndTime |
string |
结束时间，格式为 yyyy-MM-dd HH:mm:ss。 |
2023-01-03 18:00:21 |
| ScheduleTime |
string |
计划调度时间，格式为 yyyy-MM-dd HH:mm:ss。 |
2023-01-03 18:00:00 |
| DataTime |
string |
数据时间，格式为 yyyy-MM-dd HH:mm:ss。 |
2023-01-03 18:00:00 |
| WfInstanceDag |
object |
工作流实例的 DAG 信息，包含了节点和边 |
|
| Nodes |
array<object> |
任务实例节点的数组 |
|
|
object |
|||
| JobInstanceId |
integer |
任务实例 ID |
24058796 |
| JobId |
integer |
任务 ID |
1472 |
| StartTime |
string |
任务开始时间，格式为 yyyy-MM-dd HH:mm:ss。 |
2023-01-03 18:00:03 |
| EndTime |
string |
任务结束时间，格式为 yyyy-MM-dd HH:mm:ss。 |
2023-01-03 18:00:21 |
| ScheduleTime |
string |
任务调度时间，格式为 yyyy-MM-dd HH:mm:ss。 |
2023-01-03 18:00:03 |
| DataTime |
string |
任务数据时间，格式为 yyyy-MM-dd HH:mm:ss。 |
2023-01-03 18:00:00 |
| WorkAddr |
string |
任务实例的运行机器 |
10.163.0.101:34027 |
| Result |
string |
任务运行结果 |
code=200 |
| Attempt |
integer |
任务失败重试次数 |
0 |
| Status |
integer |
实例状态。包含以下几种状态： 1：等待 3：运行中 4：成功 5：失败 9：拒绝 对应枚举类： com.alibaba.schedulerx.common.domain.InstanceStatus |
4 |
| JobName |
string |
任务名称 |
TestJob |
| Edges |
array<object> |
任务实例依赖关系的数组 |
|
|
object |
通过 source->target 描述依赖关系，source=0 表示根节点 |
||
| Source |
integer |
依赖关系的上游，0 表示根节点 |
24058798 |
| Target |
integer |
依赖关系的下游 |
24058796 |
示例
正常返回示例
JSON格式
{
"RequestId": "39090022-1F3B-4797-8518-6B61095F1AF0",
"Code": 200,
"Success": true,
"Message": "workflowId=xxx is not existed",
"Data": {
"WfInstanceInfo": {
"Status": 5,
"StartTime": "2023-01-03 18:00:01",
"EndTime": "2023-01-03 18:00:21",
"ScheduleTime": "2023-01-03 18:00:00",
"DataTime": "2023-01-03 18:00:00"
},
"WfInstanceDag": {
"Nodes": [
{
"JobInstanceId": 24058796,
"JobId": 1472,
"StartTime": "2023-01-03 18:00:03",
"EndTime": "2023-01-03 18:00:21",
"ScheduleTime": "2023-01-03 18:00:03",
"DataTime": "2023-01-03 18:00:00",
"WorkAddr": "10.163.0.101:34027",
"Result": "code=200",
"Attempt": 0,
"Status": 4,
"JobName": "TestJob"
}
],
"Edges": [
{
"Source": 24058798,
"Target": 24058796
}
]
}
}
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。