Query pipeline jobs with ListPipelineRuns - Platform For AI - Alibaba Cloud - Platform For AI

Queries a list of pipeline jobs. Filtering, sorting, and pagination are supported.

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

paiflow:ListPipelineRuns

list

*All Resource

*

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 pipeline job source ID. You can find this ID 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 pipeline IDs, separated by commas (,). You can call ListPipelines to obtain pipeline IDs.	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 elements

Element	Type	Description	Example
	object	The returned data.
RequestId	string	The request ID.	473469C7-**--**-A3DC0DE3C83E
TotalCount	integer	The total number of returned pipeline jobs.	15
PipelineRuns	array<object>	The queried pipeline jobs.
	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 user's primary account.	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 when the pipeline job ends, in UTC. The time follows the ISO 8601 standard.	2021-01-30T12:52:33.028Z
NodeId	string	The node ID on which the pipeline job runs.	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 source ID of the pipeline job.	abcd*********hxfu
GmtCreateTime	string	The time when the pipeline job is created, in UTC. The time follows 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 follows 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

Success response

JSON format

{
  "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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.