ListPipelineRuns - Platform For AI - Alibaba Cloud Documentation Center

Queries a list of pipeline jobs. Filtering, sorting, and pagination are supported for this API operation.

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.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
paiflow:ListPipelineRuns	list	All Resources ``	none	none

Request syntax

GET /api/v1/pipelineruns HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
PageNumber	integer	No	The page number. Pages start from page 1. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Default value: 10.	10
SourceId	string	No	The ID of the pipeline job source. You can view the ID of the pipeline job source on the pipeline details page. For more information, see Manage pipelines.	ybpy**********fb2z
Name	string	No	The name of the pipeline job.	testName
Order	string	No	The sorting order. You must specify this parameter together with the SortBy parameter. Valid values: ASC: ascending order. DESC: descending order. This is the default value.	DESC
SourceType	string	No	The type of the pipeline job source. Valid values: UNKNOWN: If you do not specify this parameter, UNKNOWN is used as the default value. SDK: The pipeline job is created by using an SDK. DESIGNER: The pipeline job is created by using Machine Learning Designer. M6: The pipeline job is created on other websites.	UNKNOWN
Status	string	No	The status of the pipeline jobs to be filtered. Valid values: Initialized Running Succeeded Failed Terminated Unknown Skipped Terminating	Succeeded
WorkspaceId	string	No	The workspace ID. You can call ListWorkspaces to obtain the workspace ID.	104623
UserId	string	No	The user ID.	155**********904
PipelineIds	string	No	The IDs of the pipelines. Multiple pipeline IDs are separated by commas (,). You can call ListPipelines to obtain the ID of the pipeline.	flow-rer7********0otv, flow-hynm********sfef
SortBy	string	No	The field for sorting. Valid values: PipelineId UserId ParentUserId StartedAt FinishedAt WorkflowServiceId Duration GmtCreateTime GmtModifiedTime	PipelineId
PipelineRunId	string	No	The pipeline job ID. You can call ListPipelineRuns to obtain the ID of the pipeline job.	flow-14vioac3k1s07k****

Response parameters

Parameter	Type	Description	Example
	object	The returned data.
RequestId	string	The request ID.	473469C7-**--**-A3DC0DE3C83E
TotalCount	long	The total amount of returned pipeline jobs.	15
PipelineRuns	array<object>	The queried pipeline jobs.
PipelineRuns	object	The details of the pipeline job.
PipelineRunId	string	The ID of the pipeline job.	flow-j94y**********lf7a
Name	string	The name of the pipeline job.	testName
Status	string	The status of the pipeline job. Valid values: Initialized Running Succeeded Failed Suspended Terminated Unknown Skipped Terminating	Succeeded
UserId	string	The user ID.	155**********904
ParentUserId	string	The ID of the primary account of the user.	155**********904
StartedAt	string	The time when the pipeline job starts, in UTC. The time follows the ISO 8601 standard.	2021-01-30T12:51:33.028Z
FinishedAt	string	The time of the pipeline job ends, in UTC. The time follows the ISO 8601 standard.	2021-01-30T12:52:33.028Z
NodeId	string	The ID of the node on which the pipeline job is executed.	node-n06d**********fc53
Duration	integer	The running duration of the pipeline job. Unit: seconds.	60
WorkspaceId	string	The workspace ID.	15945
Message	string	The failure message of the pipeline job.	error message
SourceType	string	The type of the pipeline job source. Valid values: UNKNOWN SDK DESIGNER M6	UNKNOWN
SourceId	string	The ID of the source for the pipeline job.	abcd*********hxfu
GmtCreateTime	string	The time when the pipeline job is created, in UTC. The time must follow the ISO 8601 standard.	2021-01-30T12:51:33.028Z
GmtModifiedTime	string	The time when the pipeline job is last modified, in UTC. The time must follow the ISO 8601 standard.	2021-01-30T12:51:33.028Z
PipelineId	string	The pipeline ID.	pipeline-j94y**********lf7a
Accessibility	string	The accessibility of the pipeline job. Valid values: PUBLIC PRIVATE	PUBLIC
PipelineRunUri	string	The URL of the pipeline job.	https://pai.console.alibabacloud.com/?regionId=cn-shanghai&workspaceId=24**#/studio/task/detail/flow-dsfbjt4k07lvp1**

Examples

Sample success responses

JSONformat

{
  "RequestId": "473469C7-****-****-****-A3DC0DE3C83E",
  "TotalCount": 15,
  "PipelineRuns": [
    {
      "PipelineRunId": "flow-j94y**********lf7a\n",
      "Name": "testName\n",
      "Status": "Succeeded",
      "UserId": "155**********904",
      "ParentUserId": "155**********904",
      "StartedAt": "2021-01-30T12:51:33.028Z\n",
      "FinishedAt": "2021-01-30T12:52:33.028Z\n",
      "NodeId": "node-n06d**********fc53\n",
      "Duration": 60,
      "WorkspaceId": 15945,
      "Message": "error message\n",
      "SourceType": "UNKNOWN",
      "SourceId": "abcd*********hxfu\n",
      "GmtCreateTime": "2021-01-30T12:51:33.028Z\n",
      "GmtModifiedTime": "2021-01-30T12:51:33.028Z\n",
      "PipelineId": "pipeline-j94y**********lf7a\n",
      "Accessibility": "PUBLIC",
      "PipelineRunUri": "https://pai.console.alibabacloud.com/?regionId=cn-shanghai&workspaceId=24****#/studio/task/detail/flow-dsfbjt4k07lvp1****"
    }
  ]
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2024-07-24	The internal configuration of the API is changed, but the call is not affected	View Change Details
2022-12-15	The response structure of the API has changed	View Change Details
2022-12-15	The request parameters of the API has changed	View Change Details
2022-07-06	The response structure of the API has changed	View Change Details
2022-06-14	Add Operation	View Change Details