ListPipelineRuns-阿里云帮助中心

Retrieve a paginated list of deployment processes. You can also filter this list based on specific criteria.

Operation description

Important Earlier SDK versions may not include this interface. If so, use the ListDeployments interface. It 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 obtain this ID from the Workspace Management page in the DataWorks console. This parameter specifies the DataWorks workspace to use for the API call.	10000
Creator	string	No	Filters the results by the creator of the pipeline.	110755000425****
Status	string	No	Filters the results by the current status of the pipeline. Valid values: `Init`: initializing `Running`: running `Success`: succeeded `Fail`: failed `Termination`: terminated `Cancel`: canceled	Running
ObjectId	string	No	The ID of the artifact.	860438872620113XXXX
PageNumber	integer	No	The page number. Pages start from 1. The default value is 1.	1
PageSize	integer	No	The number of entries per page. Default value: 10. Maximum value: 100.	10

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID. 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 meet the filter criteria.	2524
PageSize	integer	The number of entries per page.	10
PageNumber	integer	The returned page number.	1
PipelineRuns	array<object>	A list of deployment pipeline runs.
	array<object>	A deployment pipeline run.
Id	string	The ID of the deployment pipeline run.	097c73fe-ed6e-4fb1-b109-a5d59e46cd58
ProjectId	integer	The project ID.	70199
CreateTime	integer	The creation timestamp of the deployment pipeline run.	1702736654000
ModifyTime	integer	The last modification timestamp of the deployment pipeline run.	1702736654000
Creator	string	The creator of the deployment pipeline run.	110755000425XXXX
Status	string	The status of the deployment pipeline run. Valid values: `Init`: Initializing `Running`: Running `Success`: Succeeded `Fail`: Failed `Termination`: Terminated `Cancel`: Canceled	Running
Message	string	The error message returned if the deployment pipeline run fails.	Error message
Stages	array<object>	A list of deployment stages.
	array<object>	A deployment stage.
Code	string	The code of the deployment stage.	DEV_CHECK
Step	integer	The step number of the deployment stage.	1
Type	string	The type of the deployment stage. Valid values: `Deploy`: A deploy operation `Check`: A check operation `Offline`: An offline operation `Build`: A build operation `Delete`: A delete operation	Check
Name	string	The stage name.	Check before going online to development
Description	string	The stage description.	Check before going online to development
Message	string	The error message returned if the deployment stage fails.	Error message
Status	string	The status of the deployment stage. Valid values: `Init`: Initializing `Running`: Running `Success`: Succeeded `Fail`: Failed `Termination`: Terminated `Cancel`: Canceled	Running
Detail	object	Additional information about the deployment stage.
	any	Additional details for the stage, returned as key-value pairs.	{ "checkerList": [ { "code": "BuildPackageChecker", "name": "package check" }, { "code": "NodeParentDependency", "name": "downstream dependency check" }, { "code": "NodeInProcess", "name": "offline process check" } ] }
Description	string	The description of the deployment 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": "发布流程描述信息"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.