All Products
Search
Document Center

DataWorks:ListPipelineRunItems

Last Updated:Jan 12, 2026

Queries the information about deployment objects by deployment process ID.

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 ID of the DataWorks workspace. You can obtain the workspace ID from the workspace configuration page in the DataWorks console.

10001
PipelineRunIdstringYes

The workflow task ID. To obtain the ID, see ListPipelineRuns .

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

The page number, for pagination.

1
PageSizeintegerNo

The requested page number, used for pagination.

10

Response parameters

ParameterTypeDescriptionExample
object

The returned result.

RequestIdstring

The request ID. You can use this ID to troubleshoot issues if errors occur.

C99E2BE6-9DEA-5C2E-8F51-1DDCFEADE490
PagingInfoobject

Pagination information.

TotalCountinteger

The total number of entries that match the conditions.

12
PageSizeinteger

The number of entries per page.

10
PageNumberinteger

The page number.

1
PipelineRunItemsarray<object>

The list of deployments.

pipelineRunobject

Details of a deployment.

Versionlong

The deployment version.

1
Namestring

The deployment name.

test
CreateTimelong

The deployment creation time.

1724984066000
ModifyTimelong

The time when the deployment was last modified.

1724984066000
Statusstring

The deployment status. Valid values:

  • Init: Initializing
  • Running
  • Success
  • Fail
  • Termination
Running
Messagestring

The error message if the deployment failed.

Error Message
Typestring

The deployment type. Valid values:

  • Node
  • WorkflowDefinition: Workflow definition.
  • Resource
  • Function: The object is a function.
Node
Specstring

The FlowSpec information describing this deployment. For detailed specifications, see FlowSpec .

{ "version": "1.1.0", "kind": "Node", "spec": { "nodes": [ { "recurrence": "Normal", "id": "860438872620113XXXX", "timeout": 0, "instanceMode": "T+1", "rerunMode": "Allowed", "rerunTimes": 3, "rerunInterval": 180000, "datasource": { "name": "odps_test", "type": "odps" }, "script": { "language": "odps-sql", "path": "XX/OpenAPI_Test/ODPS_SQL_Test", "runtime": { "command": "ODPS_SQL", "commandTypeId": 10 }, "content": "select now();", "id": "853573334108680XXXX" }, "trigger": { "type": "Scheduler", "id": "543680677872062XXXX", "cron": "00 00 00 * * ?", "startTime": "1970-01-01 00:00:00", "endTime": "9999-01-01 00:00:00", "timezone": "Asia/Shanghai", "delaySeconds": 0 }, "runtimeResource": { "resourceGroup": "S_res_group_XXXX_XXXX", "id": "623731286945488XXXX", "resourceGroupId": "7201XXXX" }, "name": "ODPS_SQL_Test", "owner": "110755000425XXXX", "metadata": { "owner": "110755000425XXXX", "ownerName": "XXXXX@test.XXX.com", "projectId": "307XXX" }, "inputs": { "nodeOutputs": [ { "data": "lwttest_standard_root", "artifactType": "NodeOutput" } ] }, "outputs": { "nodeOutputs": [ { "data": "860438872620113XXXX", "artifactType": "NodeOutput", "refTableName": "ODPS_SQL_Test", "isDefault": true } ] } } ], "flow": [ { "nodeId": "860438872620113XXXX", "depends": [ { "type": "Normal", "output": "lwttest_standard_root" } ] } ] }, "metadata": { "uuid": "860438872620113XXXX" } }
Idinteger

The unique identifier of the deployment.

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.
860438872620113XXXX

Examples

Sample success responses

JSONformat

{
  "RequestId": "C99E2BE6-9DEA-5C2E-8F51-1DDCFEADE490",
  "PagingInfo": {
    "TotalCount": 12,
    "PageSize": 10,
    "PageNumber": 1,
    "PipelineRunItems": [
      {
        "Version": 1,
        "Name": "test",
        "CreateTime": 1724984066000,
        "ModifyTime": 1724984066000,
        "Status": "Running",
        "Message": "Error Message",
        "Type": "Node",
        "Spec": {
          "version": "1.1.0",
          "kind": "Node",
          "spec": {
            "nodes": [
              {
                "recurrence": "Normal",
                "id": "860438872620113XXXX",
                "timeout": 0,
                "instanceMode": "T+1",
                "rerunMode": "Allowed",
                "rerunTimes": 3,
                "rerunInterval": 180000,
                "datasource": {
                  "name": "odps_test",
                  "type": "odps"
                },
                "script": {
                  "language": "odps-sql",
                  "path": "XX/OpenAPI_Test/ODPS_SQL_Test",
                  "runtime": {
                    "command": "ODPS_SQL",
                    "commandTypeId": 10
                  },
                  "content": "select now();",
                  "id": "853573334108680XXXX"
                },
                "trigger": {
                  "type": "Scheduler",
                  "id": "543680677872062XXXX",
                  "cron": "00 00 00 * * ?",
                  "startTime": "1970-01-01 00:00:00",
                  "endTime": "9999-01-01 00:00:00",
                  "timezone": "Asia/Shanghai",
                  "delaySeconds": 0
                },
                "runtimeResource": {
                  "resourceGroup": "S_res_group_XXXX_XXXX",
                  "id": "623731286945488XXXX",
                  "resourceGroupId": "7201XXXX"
                },
                "name": "ODPS_SQL_Test",
                "owner": "110755000425XXXX",
                "metadata": {
                  "owner": "110755000425XXXX",
                  "ownerName": "XXXXX@test.XXX.com",
                  "projectId": "307XXX"
                },
                "inputs": {
                  "nodeOutputs": [
                    {
                      "data": "lwttest_standard_root",
                      "artifactType": "NodeOutput"
                    }
                  ]
                },
                "outputs": {
                  "nodeOutputs": [
                    {
                      "data": "860438872620113XXXX",
                      "artifactType": "NodeOutput",
                      "refTableName": "ODPS_SQL_Test",
                      "isDefault": true
                    }
                  ]
                }
              }
            ],
            "flow": [
              {
                "nodeId": "860438872620113XXXX",
                "depends": [
                  {
                    "type": "Normal",
                    "output": "lwttest_standard_root"
                  }
                ]
              }
            ]
          },
          "metadata": {
            "uuid": "860438872620113XXXX"
          }
        },
        "Id": 0
      }
    ]
  }
}

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