GetWorkflowDAG - 获取工作流DAG信息

获取工作流DAG信息

调试

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

授权信息

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

请求参数

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

集群 ID。

xxljob-a1804a3226d
AppNamestring

应用名称

test-app
WorkflowIdlong

工作流 ID

20

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

Id of the request

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

响应码。

200
Messagestring

错误信息。

Parameter error: content is null.
Successboolean

是否成功。

true
Dataobject

查询结果。

Nodesarray<object>

返回的数据类型。

Nodesobject

返回的数据类型。

Idlong

任务 ID

5
Namestring

任务名称。

job1
AppNamestring

应用名称。

oak-payment-async-job
Statusinteger

任务状态

  • 0:禁用
  • 1:启用
1
JobTypestring

任务类型。

script_shell
Coordinateobject

节点的坐标信息

Xfloat

节点的 X 轴坐标

50
Yfloat

节点的 Y 轴坐标

50
Widthfloat

节点宽度,可以不填

100
Heightfloat

节点高度,可以不填

20
DependentStrategyinteger

依赖策略

all_success
Edgesarray<object>

工作流边列表

Edgesobject

节点之间的边

Sourcelong

边起点的任务 ID

3
Targetlong

边终点的任务 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错误码错误信息描述
400InvalidParameterParameter error: %s.参数错误: %s
401IllegalRequestIllegalRequest: %s.非法请求:%s
403NoPermissionNo permission to perform this operation: %s.没有权限去执行该操作:%s
404NotFoundNot found: %s.资源不存在:%s
500InternalErrorInternalError: %s.系统内部错误:%s

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

变更历史

变更时间变更内容概要操作
2025-12-25新增 OpenAPI查看变更详情