GetWorkflowDAG

更新时间:
复制 MD 格式

Gets the Directed Acyclic Graph (DAG) of a workflow.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request syntax

GET  HTTP/1.1

Request parameters

Parameter

Type

Required

Description

Example

ClusterId

string

Yes

The cluster ID.

xxljob-a1804a3226d

AppName

string

Yes

The application name.

test-app

WorkflowId

integer

No

The workflow ID.

20

Response elements

Element

Type

Description

Example

object

The response object.

RequestId

string

The Request ID.

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

Code

integer

The Response Code.

200

Message

string

The Error Message.

Parameter error: content is null.

Success

boolean

Indicates whether the request succeeded.

true

Data

object

The returned data.

Nodes

array<object>

A list of Nodes in the Workflow DAG.

array<object>

An object representing a Node in the DAG.

Id

integer

The Job ID.

5

Name

string

The Job name.

job1

AppName

string

The Application Name.

oak-payment-async-job

Status

integer

The Job Status.

  • 0: Disabled

  • 1: Enabled

1

JobType

string

The Job type.

script_shell

Coordinate

object

The coordinates of the Node.

X

number

The x-coordinate of the Node.

50

Y

number

The y-coordinate of the Node.

50

Width

number

Optional. The width of the Node.

100

Height

number

Optional. The height of the Node.

20

DependentStrategy

integer

The Dependency Strategy.

all_success

Edges

array<object>

A list of Edges in the Workflow DAG.

object

An object representing an Edge between two Nodes.

Source

integer

The Job ID of the source Node.

3

Target

integer

The Job ID of the target Node.

4

Examples

Success response

JSON format

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

Error codes

HTTP status code

Error code

Error message

Description

400 InvalidParameter Parameter error: %s. Parameter error: %s
401 IllegalRequest IllegalRequest: %s. Illegal request:%s
500 InternalError InternalError: %s. System Internal Error: %s
403 NoPermission No permission to perform this operation: %s. No permission to perform this operation: %s
404 NotFound Not found: %s. The resource does not exist: %s

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.