All Products
Search
Document Center

DataWorks:ListPipelineRuns

Last Updated:Jan 12, 2026

Queries a list of processes that are used to deploy or undeploy entities in DataStudio. You can also specify filter conditions to query specific processes.

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
ProjectIdlongYes

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
CreatorstringNo

The ID of the user who creates the processes. This parameter specifies a filter condition.

110755000425****
StatusstringNo

The status of the processes. This parameter specifies a filter condition.

Valid values:

  • Init
  • Running
  • Success
  • Fail
  • Termination
  • Cancel
Running
PageNumberintegerNo

The page number. Pages start from page 1. Default value: 1.

1
PageSizeintegerNo

The number of entries per page. Default value: 10. Maximum value: 100.

10

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

7C352CB7-CD88-50CF-9D0D-E81BDF02XXXX
PagingInfoobject

The pagination information.

TotalCountinteger

The total number of entries returned.

2524
PageSizeinteger

The number of entries per page.

10
PageNumberinteger

The page number.

1
PipelineRunsarray<object>

The processes.

pipelineRunobject

The information about the process.

Idstring

The process ID.

097c73fe-ed6e-4fb1-b109-a5d59e46cd58
ProjectIdlong

The DataWorks workspace ID.

70199
CreateTimelong

The time when the process was created. This value is a UNIX timestamp.

1702736654000
ModifyTimelong

The time when the process was modified. This value is a UNIX timestamp.

1702736654000
Creatorstring

The creator of the process.

110755000425XXXX
Statusstring

The status of the process.

Valid values:

  • Init
  • Running
  • Success
  • Fail
  • Termination
  • Cancel
Running
Messagestring

The error message returned during the stage.

Error message
Stagesarray<object>

The stages of the process.

stageobject

The information about the stage.

Codestring

The code of the stage.

DEV_CHECK
Stepinteger

The step number of the stage.

1
Typestring

The type of the stage. This parameter indicates the operation type in the stage.

Valid values:

  • Deploy
  • Check
  • Offline
  • Build
  • Delete
Check
Namestring

The name of the stage.

Check before going online to development
Descriptionstring

The description of the stage.

Check before going online to development
Messagestring

The error message returned during the stage.

Error message
Statusstring

The status of the stage.

Valid values:

  • Init
  • Running
  • Success
  • Fail
  • Termination
  • Cancel
Running
Detailobject

The additional information about the stage.

any

The additional information.

{ "checkerList": [ { "code": "BuildPackageChecker", "name": "package check" }, { "code": "NodeParentDependency", "name": "downstream dependency check" }, { "code": "NodeInProcess", "name": "offline process check" } ] }

Examples

Sample success responses

JSONformat

{
  "RequestId": "7C352CB7-CD88-50CF-9D0D-E81BDF02XXXX\n",
  "PagingInfo": {
    "TotalCount": 2524,
    "PageSize": 10,
    "PageNumber": 1,
    "PipelineRuns": [
      {
        "Id": "097c73fe-ed6e-4fb1-b109-a5d59e46cd58",
        "ProjectId": 70199,
        "CreateTime": 1702736654000,
        "ModifyTime": 1702736654000,
        "Creator": "110755000425XXXX",
        "Status": "Running",
        "Message": "Error message",
        "Stages": [
          {
            "Code": "DEV_CHECK",
            "Step": 1,
            "Type": "Check",
            "Name": "Check before going online to development\n",
            "Description": "Check before going online to development\n",
            "Message": "Error message\n",
            "Status": "Running",
            "Detail": {
              "key": {
                "checkerList": [
                  {
                    "code": "BuildPackageChecker",
                    "name": "package check"
                  },
                  {
                    "code": "NodeParentDependency",
                    "name": "downstream dependency check"
                  },
                  {
                    "code": "NodeInProcess",
                    "name": "offline process check"
                  }
                ]
              }
            }
          }
        ]
      }
    ]
  }
}

Error codes

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

Change history

Change timeSummary of changesOperation
2026-01-06The request parameters of the API has changed. The response structure of the API has changedView Change Details