Call ListPipelineRunsStatus to query the status of multiple pipeline jobs and nodes - Platform For AI - Alibaba Cloud - Platform For AI

Queries the statuses of multiple pipeline jobs or nodes in a single request.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request syntax

PUT /api/v1/pipelineruns HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
body	object	No	The request body.
PipelineRuns	array	No	The pipeline jobs to query. You must specify either PipelineRuns or Nodes. We recommend that you specify Nodes.
	string	No	The pipeline job ID. You can call ListPipelineRuns to obtain the pipeline job ID.	flow-hynm2bv8wqhp5esfxq
Nodes	array<object>	No	The nodes to query. You must specify either PipelineRuns or Nodes. We recommend that you specify Nodes.
	object	No	The node to query.
PipelineRunId	string	No	The pipeline job ID. You can call ListPipelineRuns to obtain the pipeline job ID.	flow-hynm2bv8wqhp5esfxq
NodeId	string	No	The pipeline node ID. You can call ListPipelineRuns to obtain the node ID.	node-hynm2bv8wqhp5esfx1
WorkspaceId	string	No	The workspace ID. 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 elements

Element	Type	Description	Example
	object	The response body.
RequestId	string	The request ID.	473469C7-**--**-A3DC0DE3C83E
PipelineRuns	array<object>	The pipeline jobs.
	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 who owns the pipeline.	1557702098194904
ParentUserId	string	The ID of the Alibaba Cloud account that owns the pipeline.	1557702098194904
NodeId	string	The node ID.	node-98odqfpcjzwdf3caq3
SourceId	string	The source ID of the pipeline job.	lmi7d24h3kr0xczjlu
IsDeleted	boolean	Indicates whether the pipeline job is deleted. Valid values: true false	false
Nodes	array<object>	The pipeline 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 artifact is archived. true false	true
OutputArtifactArchived	boolean	Indicates whether the output artifact is archived. true false	true
StartedAt	string	The time when the pipeline node started running. The time is in UTC and 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. The time is in UTC and 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.
	array<object>	The output of the pipeline node.
Name	string	The output name of 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 pipeline node ID to which the output belongs.	node-obpzu*******418grb7
PipelineRunId	string	The pipeline job ID 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

Success response

JSON format

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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.