GetWorkflowExecutionDAG-阿里云帮助中心

Retrieve the DAG information for a workflow instance.

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-b6ec1xxxx
AppName	string	Yes	The application name.	test-app
WorkflowExecutionId	integer	Yes	The workflow execution ID.	100

Response elements

Element	Type	Description	Example
	object	The response object.
RequestId	string	The ID of the request.	3835AA29-2298-5434-BC53-9CC377CDFD2C
Code	integer	The response code.	200
Message	string	The error message.	Parameter format error
Success	boolean	Indicates whether the API call succeeded. `true`: The call succeeded. `false`: The call failed.	true
Data	object	The data returned for the request.
Nodes	array<object>	A list of nodes in the workflow DAG.
	array<object>	Information about a node in the DAG.
Id	string	The unique ID for the job execution (node).	7491777526619542799
Name	string	The job name.	job1
AppName	string	The application name.	cua-xxl-job-executor
Status	integer	The execution status of the job. Valid values: 0: Unknown 1: Waiting 2: Queued 3: Running 4: Succeeded 5: Failed 6: Killed 7: Held 8: Marked as successful 9: Skipped	4
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	The width of the node. This parameter is optional.	100
Height	number	The height of the node. This parameter is optional.	20
JobId	integer	The job ID.	9
Edges	array<object>	A list of edges in the workflow DAG.
	object	Defines a directed edge from the node identified by `Source` to the node identified by `Target`. If the value of `Source` is `0`, the edge originates from the root node.
Source	string	The ID of the source node.	1000
Target	string	The ID of the target node.	1001

Examples

Success response

JSON format

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

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.