GetWorkflowInstance - SchedulerX - Alibaba Cloud Documentation Center

Queries the details of a specified workflow instance, including the state of the workflow instance, the state of each job instance, and the dependencies between job instances. You can call this operation only in the professional edition.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
edas:ReadSchedulerxWorkflowQuery	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID.	cn-hangzhou
Namespace	string	Yes	The namespace ID. You can obtain the namespace ID on the Namespace page in the SchedulerX console.	adcfc35d-e2fe-4fe9-bbaa-20e90ffc****
NamespaceSource	string	No	The source of the namespace. This parameter is required only for a special third party.	schedulerx
GroupId	string	Yes	The application group ID. You can obtain the ID on the Application Management page in the SchedulerX console.	testSchedulerx.defaultGroup
WorkflowId	long	Yes	The workflow ID.	123
WfInstanceId	long	Yes	The workflow instance ID.	123456

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	39090022-1F3B-4797-8518-6B61095F1AF0
Code	integer	The HTTP status code.	200
Success	boolean	Indicates whether the request was successful. Valid values: true false	true
Message	string	The returned error message.	workflowId=xxx is not existed
Data	object	The details of the workflow instance.
WfInstanceInfo	object	The details of the workflow instance, including the state of the workflow instance, the time when the workflow instance started to run, the time when the workflow instance stopped running, the state of each job instance, and the dependencies between job instances.
Status	integer	The state of the workflow instance. Valid values: 1: pending 2: preparing 3: running 4: successful 5: failed	5
StartTime	string	The time when the workflow instance started to run.	2023-01-03 18:00:01
EndTime	string	The time when the workflow instance stopped running.	2023-01-03 18:00:21
ScheduleTime	string	The time when the workflow instance was scheduled to run.	2023-01-03 18:00:00
DataTime	string	The data timestamp of the workflow instance.	2023-01-03 18:00:00
WfInstanceDag	object	The directed acyclic graph (DAG) of the workflow instance, including nodes and dependencies.
Nodes	array<object>	The job instances.
Node	object
JobInstanceId	long	The ID of the job instance.	24058796
JobId	long	The job ID.	1472
StartTime	string	The time when the job started to run.	2023-01-03 18:00:03
EndTime	string	The time when the job stopped running.	2023-01-03 18:00:21
ScheduleTime	string	The time when the job was scheduled.	2023-01-03 18:00:03
DataTime	string	The data timestamp of the job.	2023-01-03 18:00:00
WorkAddr	string	The worker on which the job instance run.	10.163.0.101:34027
Result	string	The execution result of the job.	code=200
Attempt	integer	The number of retries when the job failed.	0
Status	integer	The state of the job instance. Valid values: 1: The job instance is waiting for execution. 3: The job instance is running. 4: The job instance is run. 5: The job instance failed to run. 9: The job instance is rejected. Enumeration class: com.alibaba.schedulerx.common.domain.InstanceStatus.	4
JobName	string	The job name.	TestJob
Edges	array<object>	The dependencies between job instances.
Edge	object	The upstream and downstream dependencies of each job instance.
Source	long	The upstream job instance of the current job instance. A value of 0 indicates that the upstream job instance is the root node.	24058798
Target	long	The downstream job instance of the current job instance.	24058796

Examples

Sample success responses

JSONformat

{
  "RequestId": "39090022-1F3B-4797-8518-6B61095F1AF0",
  "Code": 200,
  "Success": true,
  "Message": "workflowId=xxx is not existed",
  "Data": {
    "WfInstanceInfo": {
      "Status": 5,
      "StartTime": "2023-01-03 18:00:01",
      "EndTime": "2023-01-03 18:00:21",
      "ScheduleTime": "2023-01-03 18:00:00",
      "DataTime": "2023-01-03 18:00:00"
    },
    "WfInstanceDag": {
      "Nodes": [
        {
          "JobInstanceId": 24058796,
          "JobId": 1472,
          "StartTime": "2023-01-03 18:00:03",
          "EndTime": "2023-01-03 18:00:21",
          "ScheduleTime": "2023-01-03 18:00:03",
          "DataTime": "2023-01-03 18:00:00",
          "WorkAddr": "10.163.0.101:34027",
          "Result": "code=200",
          "Attempt": 0,
          "Status": 4,
          "JobName": "TestJob"
        }
      ],
      "Edges": [
        {
          "Source": 24058798,
          "Target": 24058796
        }
      ]
    }
  }
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-10-18	The response structure of the API has changed	View Change Details
2023-07-17	The response structure of the API has changed	View Change Details
2023-07-17	The response structure of the API has changed	View Change Details