ListPipelineRuns API Overview for DataStudio Pipeline History - DataWorks - Alibaba Cloud - DataWorks

Returns a paginated list of Deployment Pipelines. Use Filter Conditions to narrow the results.

Operation description

Important This API may not be available in earlier versions of the SDK. In that case, use the ListDeployments API, which accepts the same parameters.

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:*

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ProjectId	integer	Yes	The ID of the DataWorks workspace. You can log on to the DataWorks console and go to the workspace management page to obtain the workspace ID. This parameter specifies the DataWorks workspace for this API call.	10000
Creator	string	No	The creator of the release pipeline. If specified, only pipeline runs created by this user are returned.	110755000425****
Status	string	No	The status of the release pipeline. If specified, only pipeline runs in the specified status are returned. Valid values: Init: Initialized Running: In progress Success: Succeeded Fail: Failed Termination: Terminated Cancel: Canceled	Running
PageNumber	integer	No	The page number. Must be an integer greater than or equal to 1. The default is 1.	1
PageSize	integer	No	The number of entries per page.	10

Response elements

Element	Type	Description	Example
	object	The response object.
RequestId	string	The ID of the request. You can use this ID to locate logs and troubleshoot issues.	7C352CB7-CD88-50CF-9D0D-E81BDF02XXXX
PagingInfo	object	The pagination information.
TotalCount	integer	The total number of entries that match the filter criteria.	2524
PageSize	integer	The number of entries per page.	10
PageNumber	integer	The page number.	1
PipelineRuns	array<object>	A list of pipeline runs.
	array<object>	The details of a pipeline run.
Id	string	The ID of the pipeline run.	097c73fe-ed6e-4fb1-b109-a5d59e46cd58
ProjectId	integer	The ID of the project.	70199
CreateTime	integer	The time when the pipeline run was created. The value is a UNIX timestamp measured in milliseconds.	1702736654000
ModifyTime	integer	The time when the pipeline run was last modified. The value is a UNIX timestamp measured in milliseconds.	1702736654000
Creator	string	The ID of the user who created the pipeline run.	110755000425XXXX
Status	string	The status of the pipeline run. Valid values: Init Running Succeeded Failed Terminated Canceled	Running
Message	string	The error message returned if the pipeline run fails.	Error message
Stages	array<object>	A list of stages in the pipeline run.
	array<object>	The details of a stage.
Code	string	The code that identifies the stage.	DEV_CHECK
Step	integer	The step number of the stage.	1
Type	string	The type of operation performed in the stage. Valid values: Deploy Check Offline Build Delete	Check
Name	string	The name of the stage.	Check before going online to development
Description	string	The description of the stage.	Check before going online to development
Message	string	The error message returned if this stage fails.	Error message
Status	string	The status of the stage. Valid values: Init Running Succeeded Failed Terminated Canceled	Running
Detail	object	Additional information about the stage.
	any	Additional properties.	{ "checkerList": [ { "code": "BuildPackageChecker", "name": "package check" }, { "code": "NodeParentDependency", "name": "downstream dependency check" }, { "code": "NodeInProcess", "name": "offline process check" } ] }
Description	string	The description of the pipeline run.	Description of the pipeline run

Examples

Success response

JSON format

{
  "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": "{\n  \"checkerList\": [\n    {\n      \"code\": \"BuildPackageChecker\",\n      \"name\": \"package check\"\n    },\n    {\n      \"code\": \"NodeParentDependency\",\n      \"name\": \"downstream dependency check\"\n    },\n    {\n      \"code\": \"NodeInProcess\",\n      \"name\": \"offline process check\"\n    }\n  ]\n}"
            }
          }
        ],
        "Description": "Description of the pipeline run"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.