GetWorkflowExecutionDAG - 获取工作流实例的DAG信息

更新时间:
复制 MD 格式

获取工作流实例的DAG信息

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求语法

GET  HTTP/1.1

请求参数

名称

类型

必填

描述

示例值

ClusterId

string

是

集群 ID

xxljob-b6ec1xxxx

AppName

string

是

应用名称

test-app

WorkflowExecutionId

integer

是

工作流执行 ID

100

返回参数

名称

类型

描述

示例值

object

Schema of Response

RequestId

string

Id of the request

3835AA29-2298-5434-BC53-9CC377CDFD2C

Code

integer

响应码。

200

Message

string

错误信息。

Parameter format error

Success

boolean

是否调用成功。

  • true:调用成功

  • false:调用失败

true

Data

object

查询结果。

Nodes

array<object>

节点信息。

array<object>

节点信息。

Id

string

ID。

7491777526619542799

Name

string

任务名称

job1

AppName

string

应用名称

cua-xxl-job-executor

Status

integer

任务执行状态。具体说明如下:

  • 0: unknown

  • 1: waiting

  • 2: queued

  • 3: running

  • 4: success

  • 5: failed

  • 6: killed

  • 7: held

  • 8: mark_success

  • 9: skipped

4

JobType

string

任务类型。

script_shell

Coordinate

object

节点的坐标信息

X

number

节点的 X 轴坐标

50

Y

number

节点的 Y 轴坐标

50

Width

number

节点宽度,可以不填

100

Height

number

节点高度,可以不填

20

JobId

integer

任务 ID。

9

Edges

array<object>

工作流的边列表。

object

通过 source->target 描述边信息,source=0 表示根节点

Source

string

边起点的任务执行 ID

1000

Target

string

边终点的任务执行 ID

1001

示例

正常返回示例

JSON格式

{
  "RequestId": "3835AA29-2298-5434-BC53-9CC377CDFD2C",
  "Code": 200,
  "Message": "Parameter format error",
  "Success": true,
  "Data": {
    "Nodes": [
      {
        "Id": "7491777526619542799",
        "Name": "job1",
        "AppName": "cua-xxl-job-executor",
        "Status": 4,
        "JobType": "script_shell",
        "Coordinate": {
          "X": 50,
          "Y": 50,
          "Width": 100,
          "Height": 20
        },
        "JobId": 9
      }
    ],
    "Edges": [
      {
        "Source": "1000",
        "Target": "1001"
      }
    ]
  }
}

错误码

HTTP status code

错误码

错误信息

描述

400 InvalidParameter Parameter error: %s. 参数错误: %s
401 IllegalRequest IllegalRequest: %s. 非法请求:%s
500 InternalError InternalError: %s. 系统内部错误:%s
403 NoPermission No permission to perform this operation: %s. 没有权限去执行该操作:%s
404 NotFound Not found: %s. 资源不存在:%s

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

变更历史

更多信息,参考变更详情。