GetWorkflowDAG - 获取工作流DAG信息

更新时间:
复制 MD 格式

获取工作流DAG信息

调试

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

调试

授权信息

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

请求语法

GET  HTTP/1.1

请求参数

名称

类型

必填

描述

示例值

ClusterId

string

是

集群 ID。

xxljob-a1804a3226d

AppName

string

是

应用名称

test-app

WorkflowId

integer

否

工作流 ID

20

返回参数

名称

类型

描述

示例值

object

Schema of Response

RequestId

string

Id of the request

5EF879D0-3B43-5AD1-9BF7-52418F9C5E73

Code

integer

响应码。

200

Message

string

错误信息。

Parameter error: content is null.

Success

boolean

是否成功。

true

Data

object

查询结果。

Nodes

array<object>

返回的数据类型。

array<object>

返回的数据类型。

Id

integer

任务 ID

5

Name

string

任务名称。

job1

AppName

string

应用名称。

oak-payment-async-job

Status

integer

任务状态

  • 0:禁用

  • 1:启用

1

JobType

string

任务类型。

script_shell

Coordinate

object

节点的坐标信息

X

number

节点的 X 轴坐标

50

Y

number

节点的 Y 轴坐标

50

Width

number

节点宽度,可以不填

100

Height

number

节点高度,可以不填

20

DependentStrategy

integer

依赖策略

all_success

Edges

array<object>

工作流边列表

object

节点之间的边

Source

integer

边起点的任务 ID

3

Target

integer

边终点的任务 ID

4

示例

正常返回示例

JSON格式

{
  "RequestId": "5EF879D0-3B43-5AD1-9BF7-52418F9C5E73",
  "Code": 200,
  "Message": "Parameter error: content is null.",
  "Success": true,
  "Data": {
    "Nodes": [
      {
        "Id": 5,
        "Name": "job1",
        "AppName": "oak-payment-async-job",
        "Status": 1,
        "JobType": "script_shell",
        "Coordinate": {
          "X": 50,
          "Y": 50,
          "Width": 100,
          "Height": 20
        },
        "DependentStrategy": 0
      }
    ],
    "Edges": [
      {
        "Source": 3,
        "Target": 4
      }
    ]
  }
}

错误码

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

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

变更历史

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