GetWorkflowInstance - 获取工作流实例详情及DAG

获取指定工作流实例的详情,包含实例状态,依赖关系,每个任务实例的状态等。专业版应用才支持。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
edas:ReadSchedulerxWorkflowQueryget
*全部资源
*

请求参数

名称类型必填描述示例值
RegionIdstring

地域 ID

cn-hangzhou
Namespacestring

命名空间 ID,在控制台的命名空间页面中获取

adcfc35d-e2fe-4fe9-bbaa-20e90ffc****
NamespaceSourcestring

特殊第三方才需要填写

schedulerx
GroupIdstring

应用分组 ID,在控制台的应用管理页面中获取

testSchedulerx.defaultGroup
WorkflowIdlong

工作流 ID

123
WfInstanceIdlong

工作流实例 ID

123456

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求唯一 ID

39090022-1F3B-4797-8518-6B61095F1AF0
Codeinteger

返回码

200
Successboolean

API 执行是否成功。取值如下:

  • true:成功。
  • false:失败。
true
Messagestring

错误信息

workflowId=xxx is not existed
Dataobject

工作流实例详情封装在 data 中

WfInstanceInfoobject

工作流实例详情,包含了工作流的状态,开始结束时间,各个任务实例的状态及依赖关系

Statusinteger

工作流实例状态,取值如下:

  • 1: 等待中
  • 2: 准备中
  • 3:运行中
  • 4:成功
  • 5:失败
5
StartTimestring

开始时间

2023-01-03 18:00:01
EndTimestring

结束时间

2023-01-03 18:00:21
ScheduleTimestring

计划调度时间

2023-01-03 18:00:00
DataTimestring

数据时间

2023-01-03 18:00:00
WfInstanceDagobject

工作流实例的 DAG 信息,包含了节点和边

Nodesarray<object>

任务实例节点的数组

Nodeobject
JobInstanceIdlong

任务实例 ID

24058796
JobIdlong

任务 ID

1472
StartTimestring

任务开始时间

2023-01-03 18:00:03
EndTimestring

任务结束时间

2023-01-03 18:00:21
ScheduleTimestring

任务调度时间

2023-01-03 18:00:03
DataTimestring

任务数据时间

2023-01-03 18:00:00
WorkAddrstring

任务实例的运行机器

10.163.0.101:34027
Resultstring

任务运行结果

code=200
Attemptinteger

任务失败重试次数

0
Statusinteger

实例状态。包含以下几种状态: 1:等待 3:运行中 4:成功 5:失败 9:拒绝 对应枚举类: com.alibaba.schedulerx.common.domain.InstanceStatus

4
JobNamestring

任务名称

TestJob
Edgesarray<object>

任务实例依赖关系的数组

Edgeobject

通过 source->target 描述依赖关系,source=0 表示根节点

Sourcelong

依赖关系的上游,0 表示根节点

24058798
Targetlong

依赖关系的下游

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
        }
      ]
    }
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-10-18OpenAPI 返回结构发生变更查看变更详情
2023-07-17OpenAPI 返回结构发生变更查看变更详情
2023-07-17OpenAPI 返回结构发生变更查看变更详情