ListPipelineRunsStatus - Platform For AI - Alibaba Cloud Documentation Center

Queries the statuses of multiple pipeline jobs or nodes at a time.

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

There is currently no authorization information disclosed in the API.

Request syntax

PUT /api/v1/pipelineruns HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
body	object	No	The request parameters.
PipelineRuns	array	No	The pipeline jobs that you want to query. You must configure PipelineRuns or Nodes. We recommend that you configure Nodes.
	string	No	The ID of the pipeline job. You can call ListPipelineRuns to obtain the ID of the pipeline job.	flow-hynm2bv8wqhp5esfxq
Nodes	array<object>	No	The nodes that you want to query. You must configure PipelineRuns or Nodes. We recommend that you configure Nodes.
	object	No	The node that you want to query.
PipelineRunId	string	No	The ID of the pipeline job. You can call ListPipelineRuns to obtain the ID of the pipeline job.	flow-hynm2bv8wqhp5esfxq
NodeId	string	No	The ID of the pipeline node. You can call ListPipelineRuns to obtain the node ID.	node-hynm2bv8wqhp5esfx1
WorkspaceId	string	No	The workspace ID. You can call ListWorkspaces to obtain the workspace ID.	948**
OutputType	string	No	The output type of the pipeline node. Valid values: Model DataSet Metrics ModelEvaluation	DataSet

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	473469C7-**--**-A3DC0DE3C83E
PipelineRuns	array<object>	The pipeline jobs.
Runs	object	The pipeline job.
PipelineRunId	string	The ID of the pipeline job.	flow-hynm2bv8wqhp5esfxq
Status	string	The status of the pipeline job.	Running
Name	string	The name of the pipeline job.	myName
UserId	string	The ID of the user to which the pipeline belongs.	1557702098194904
ParentUserId	string	The ID of the Alibaba Cloud account to which the pipeline belongs.	1557702098194904
NodeId	string	The node ID.	node-98odqfpcjzwdf3caq3
SourceId	string	The ID of the pipeline job source.	lmi7d24h3kr0xczjlu
IsDeleted	boolean	Indicates whether the pipeline job was deleted. Valid values: true false	false
Nodes	array<object>	The pipeline nodes.
Nodes	object	The pipeline node.
PipelineRunId	string	The ID of the pipeline job.	flow-hynm2bv8wqhp5esfxq
NodeId	string	The ID of the pipeline node.	node-hynm2bv8wqhp5esfx1
Status	string	The status of the pipeline node.	Running
InputArtifactArchived	boolean	Indicates whether the input was saved. true false	true
OutputArtifactArchived	boolean	Indicates whether the output was saved. true false	true
StartedAt	string	The time when the pipeline node started to run, in UTC. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format.	2021-01-21T17:12:35.232Z
FinishedAt	string	The time when the pipeline node finished running, in UTC. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format.	2021-01-21T17:12:35.232Z
NodeName	string	The name of the pipeline node.	dataSource
Outputs	array<object>	The outputs of the pipeline node.
Outputs	object	The output of the pipeline node.
Name	string	The name of the output for the pipeline node.	model_******
Type	string	The output type. Valid values: Model DataSet Metrics ModelEvaluation	DataSet
Metadata	object	The output metadata.
GmtCreateTime	string	The time when the output was created.	2021-01-30T12:51:33.028Z
Id	string	The output ID.	artifact-ty1xwv*******s8zf
Producer	string	The output producer.	id-3d25-************-77856
NodeId	string	The ID of the pipeline node to which the output belongs.	node-obpzu*******418grb7
PipelineRunId	string	The ID of the pipeline job to which the output belongs.	flow-dsjfk******jdskls
Value	string	The output value.	{\"name\": \"model_flow_*******_node_******_model\", \"location\": {\"name\": \"model_flow_******_node_*******_model\", \"endpoint\": \"http://service.odps.aliyun.com/api\", \"project\": \"******\"}}
ExpandedArtifactIndex	integer	The expanded index number of the output, starting from 0.	0
ExpandableArtifactName	string	The expandable name of the output.	inputArtifact

Examples

Sample success responses

JSONformat

{
  "RequestId": "473469C7-****-****-****-A3DC0DE3C83E",
  "PipelineRuns": [
    {
      "PipelineRunId": "flow-hynm2bv8wqhp5esfxq",
      "Status": "Running",
      "Name": "myName",
      "UserId": 1557702098194904,
      "ParentUserId": 1557702098194904,
      "NodeId": "node-98odqfpcjzwdf3caq3",
      "SourceId": "lmi7d24h3kr0xczjlu",
      "IsDeleted": false
    }
  ],
  "Nodes": [
    {
      "PipelineRunId": "flow-hynm2bv8wqhp5esfxq",
      "NodeId": "node-hynm2bv8wqhp5esfx1",
      "Status": "Running",
      "InputArtifactArchived": true,
      "OutputArtifactArchived": true,
      "StartedAt": "2021-01-21T17:12:35.232Z",
      "FinishedAt": "2021-01-21T17:12:35.232Z",
      "NodeName": "dataSource"
    }
  ],
  "Outputs": [
    {
      "Name": "model_******",
      "Type": "DataSet",
      "Metadata": {
        "test": "test",
        "test2": 1
      },
      "GmtCreateTime": "2021-01-30T12:51:33.028Z",
      "Id": "artifact-ty1xwv*******s8zf",
      "Producer": "id-3d25-************-77856",
      "NodeId": "node-obpzu*******418grb7\n",
      "PipelineRunId": "flow-dsjfk******jdskls",
      "Value": "{\\\"name\\\": \\\"model_flow_*********_node_**********_model\\\", \\\"location\\\": {\\\"name\\\": \\\"model_flow_**********_node_***********_model\\\", \\\"endpoint\\\": \\\"http://service.odps.aliyun.com/api\\\", \\\"project\\\": \\\"********\\\"}}",
      "ExpandedArtifactIndex": 0,
      "ExpandableArtifactName": "inputArtifact"
    }
  ]
}

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-06-14	Add Operation	View Change Details