Workflow Instance Details API Reference - DataWorks - Alibaba Cloud - DataWorks

Queries the information about a workflow instance.

Operation description

You must purchase DataWorks Basic Edition or a higher edition to use this feature.

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

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dataworks:*

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Id	integer	Yes	The ID of the workflow instance.	1234

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	22C97E95-F023-56B5-8852-B1A77A17XXXX
WorkflowInstance	object	The information about the workflow instance.
Id	integer	The ID of the workflow instance.	1234
WorkflowId	integer	The ID of the workflow to which the instance belongs.	1234
WorkflowTaskInstanceId	integer	The task instance ID corresponding to the workflow instance.	1234
UnifiedWorkflowInstanceId	integer	The unified pipeline instance ID. For all pipeline instances triggered under the same data timestamp in a single trigger, this field value is identical.	1234
Name	string	The name of the workflow instance.	WorkInstance1
Type	string	The type of the workflow instance. Valid values: Normal: Scheduled execution Manual: Manually triggered node SmokeTest: Testing SupplementData: Data backfill ManualWorkflow: Manually triggered workflow TriggerWorkflow: Triggered Workflow	Normal
Status	string	The status of the workflow instance. Valid values: NotRun: The instance is not run. Running: The instance is running. WaitTime: The instance is waiting for the scheduling time to arrive. CheckingCondition: Branch conditions are being checked for the instance. WaitResource: The instance is waiting for resources. Failure: The instance fails to be run. Success: The instance is successfully run. Checking: Data quality is being checked for the instance.	Success
BizDate	integer	The data timestamp.	1710239005403
StartedTime	integer	The time when the instance started to run.	1710239005403
FinishedTime	integer	The time when the instance finished running.	1710239005403
ProjectId	integer	The workspace ID.	100
EnvType	string	The environment of the workspace. Valid values: Prod Dev	Prod
Owner	string	The account ID of the workflow owner.	1000
CreateTime	integer	The creation time.	1710239005403
ModifyTime	integer	The modification time.	1710239005403
CreateUser	string	The account ID of the creator.	1000
ModifyUser	string	The account ID of the modifier.	1000
WorkflowParameters	string	The workflow parameters.	Periodic workflow: key1=value1 key2=value2 Manual workflow: {"key1":"value1", "key2": "value2"}
Tags	array<object>	The task tag.
	object
Key	string	The key of a tag.	key1
Value	string	The value of a tag.	value1

Examples

Success response

JSON format

{
  "RequestId": "22C97E95-F023-56B5-8852-B1A77A17XXXX",
  "WorkflowInstance": {
    "Id": 1234,
    "WorkflowId": 1234,
    "WorkflowTaskInstanceId": 1234,
    "UnifiedWorkflowInstanceId": 1234,
    "Name": "WorkInstance1",
    "Type": "Normal",
    "Status": "Success",
    "BizDate": 1710239005403,
    "StartedTime": 1710239005403,
    "FinishedTime": 1710239005403,
    "ProjectId": 100,
    "EnvType": "Prod",
    "Owner": "1000",
    "CreateTime": 1710239005403,
    "ModifyTime": 1710239005403,
    "CreateUser": "1000",
    "ModifyUser": "1000",
    "WorkflowParameters": "Periodic workflow:\nkey1=value1 key2=value2\nManual workflow:\n{\"key1\":\"value1\", \"key2\": \"value2\"}",
    "Tags": [
      {
        "Key": "key1",
        "Value": "value1"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.