GetWorkflowDefinition - DataWorks - Alibaba Cloud Documentation Center

Queries the information about a workflow.

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

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
ProjectId	string	No	The DataWorks workspace ID. You can log on to the DataWorks console and go to the Workspace page to query the ID. You must configure this parameter to specify the DataWorks workspace to which the API operation is applied.	10000
Id	string	Yes	The ID of the workflow.	860438872620113XXXX

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	F2BDD628-8A21-5BD1-B930-1A2D5989XXXX
WorkflowDefinition	object	The information about the workflow.
Id	string	The ID of the workflow.	463497880880954XXXX
ProjectId	string	The ID of the workspace to which the workflow belongs.	307XXX
Name	string	The name of the workflow.
Owner	string	The owner of the workflow.	110755000425XXXX
CreateTime	long	The time when the workflow was created. This value is a UNIX timestamp.	1708481905000
ModifyTime	long	The time when the workflow was last modified. This value is a UNIX timestamp.	1708481905000
Spec	string	The FlowSpec field information about the workflow. For more information, see FlowSpec .

Examples

Sample success responses

JSONformat

{
  "RequestId": "F2BDD628-8A21-5BD1-B930-1A2D5989XXXX",
  "WorkflowDefinition": {
    "Id": "463497880880954XXXX",
    "ProjectId": "307XXX",
    "Name": "",
    "Owner": "110755000425XXXX",
    "CreateTime": 1708481905000,
    "ModifyTime": 1708481905000,
    "Spec": ""
  }
}

Error codes

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

Change history

Change time	Summary of changes	Operation

No change history