All Products
Search
Document Center

DataWorks:ListWorkflowDefinitions

Last Updated:Jan 12, 2026

Queries a list of workflows in DataStudio. You can also specify filter conditions to query specific workflows.

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.

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:
    • For mandatory resource types, indicate with a prefix of * .
    • 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.
OperationAccess levelResource typeCondition keyAssociated operation
dataworks:*list
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ProjectIdstringYes

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
TypestringNo

Filter condition: The type of the workflow. The default value is CycleWorkflow.

Valid values:

  • CycleWorkflow
  • ManualWorkflow
CycleWorkflow
OwnerstringNo

Filter condition: The type of the workflow. The default value is CycleWorkflow.

Valid values:

  • CycleWorkflow
  • ManualWorkflow
110755000425XXXX
NamestringNo

The name of the workflow. Fuzzy search is supported.

test
PageNumberintegerNo

The page number of the data to retrieve, used for pagination.

1
PageSizeintegerNo

The page number of the data to retrieve, used for pagination.

10

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

The request ID.

8C3ED0C5-ABAB-55E1-854B-DAC02B11XXXX
PagingInfoobject

The pagination information.

TotalCountinteger

The total number of entries returned.

227
PageSizeinteger

The number of entries per page.

10
PageNumberinteger

The page number.

1
WorkflowDefinitionsarray<object>

The workflows.

workflowDefinitionobject
ProjectIdstring

The ID of the DataWorks workspace to which the workflow belongs.

4710
Ownerstring

Owner

110755000425XXXX
CreateTimelong

The timestamp when the workflow was created.

1698057323000
ModifyTimelong

The timestamp when the workflow was last modified.

1698057323000
Descriptionstring

Description

Workflow description
Typestring

The type of the workflow.

Valid values:

  • CycleWorkflow
  • ManualWorkflow
CycleWorkflow
Scriptobject

The script information.

Pathstring

The script path.

XX/OpenAPI_test/workflow_test/OpenAPI_test_workflow_Demo
Runtimeobject

Runtime

Commandstring

Command

WORKFLOW
Idstring

The ID of the script.

Note This field is of type Long in SDK versions prior to 8.0.0, and of type String in SDK version 8.0.0 and later. This change does not affect the normal use of the SDK. The parameter is returned based on the type defined in the SDK. Compilation failures due to the type change may occur only when upgrading the SDK across version 8.0.0, in which case users need to manually correct the data type.
698002781368644XXXX
Namestring

The name of the workflow.

OpenAPI test workflow Demo
Idstring

The unique identifier of the workflow.

Note Prior to SDK version 8.0.0, this field is of type Long. In SDK version 8.0.0 and later, it is of type String. This change does not affect the normal use of the SDK. The parameter is returned based on the type defined in the SDK. Compilation failures caused by the type change may occur only when you upgrade the SDK across version 8.0.0. In this case, you must manually update the data type.
463497880880954XXXX

Examples

Sample success responses

JSONformat

{
  "RequestId": "8C3ED0C5-ABAB-55E1-854B-DAC02B11XXXX",
  "PagingInfo": {
    "TotalCount": 227,
    "PageSize": 10,
    "PageNumber": 1,
    "WorkflowDefinitions": [
      {
        "ProjectId": 4710,
        "Owner": "110755000425XXXX",
        "CreateTime": 1698057323000,
        "ModifyTime": 1698057323000,
        "Description": "Workflow description",
        "Type": "CycleWorkflow",
        "Script": {
          "Path": "XX/OpenAPI_test/workflow_test/OpenAPI_test_workflow_Demo",
          "Runtime": {
            "Command": "WORKFLOW"
          },
          "Id": "698002781368644XXXX"
        },
        "Name": "OpenAPI test workflow Demo",
        "Id": "463497880880954XXXX"
      }
    ]
  }
}

Error codes

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

Change history

Change timeSummary of changesOperation
2025-12-29The response structure of the API has changedView Change Details
2025-01-13The response structure of the API has changedView Change Details