文档

ListPipelineRunsStatus - 批量获取工作流任务状态

更新时间:

批量获取工作流任务或节点的状态。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求语法

PUT /api/v1/pipelineruns

请求参数

名称类型必填描述示例值
bodyobject

查询请求。

PipelineRunsarray

要查询的工作流任务列表,PipelineRuns参数与Nodes参数两选一,优先Nodes。

string

工作流任务的ID。如何获取工作流任务ID,请参见ListPipelineRuns

flow-hynm2bv8wqhp5esfxq
Nodesarray

要查询的节点列表,Nodes参数与PipelineRuns参数两选一,优先Nodes。

object

要查询的节点。

PipelineRunIdstring

工作流任务的ID。如何获取工作流任务ID,请参见ListPipelineRuns

flow-hynm2bv8wqhp5esfxq
NodeIdstring

工作流任务节点的ID。如何获取节点ID,请参见ListPipelineRuns

node-hynm2bv8wqhp5esfx1
WorkspaceIdstring

工作空间的ID。如何获取工作空间ID,请参见ListWorkspaces

948**
OutputTypestring

工作流任务节点产物(Artifact)的类型,取值如下:

  • Model:模型。
  • DataSet:数据集。
  • Metrics:度量数据。
  • ModelEvaluation:模型评估结果。
DataSet

返回参数

名称类型描述示例值
object

返回结构体。

RequestIdstring

请求ID。

473469C7-****-****-****-A3DC0DE3C83E
PipelineRunsarray

工作流任务列表。

object

工作流任务。

PipelineRunIdstring

工作流任务ID。

flow-hynm2bv8wqhp5esfxq
Statusstring

工作流任务状态。

Running
Namestring

工作流任务名字。

myName
UserIdstring

工作流所属用户ID。

1557702098194904
ParentUserIdstring

工作流所属主账户ID。

1557702098194904
NodeIdstring

节点ID。

node-98odqfpcjzwdf3caq3
SourceIdstring

工作流任务来源ID。

lmi7d24h3kr0xczjlu
IsDeletedboolean

是否被删除,可能值:

  • true:代表已被删除。
  • false:代表未被删除。
false
Nodesarray

工作流任务节点列表。

object

工作流任务节点。

PipelineRunIdstring

工作流任务ID。

flow-hynm2bv8wqhp5esfxq
NodeIdstring

工作流任务节点ID。

node-hynm2bv8wqhp5esfx1
Statusstring

工作流任务节点状态。

Running
InputArtifactArchivedboolean

输入Artifact是否已保存:

  • true:表示已保存。
  • false:表示未保存。
true
OutputArtifactArchivedboolean

输出Artifact是否已保存:

  • true:表示已保存。
  • false:表示未保存。
true
StartedAtstring

工作流任务节点的开始运行时间。按照ISO8601标准表示,使用UTC+0时间。格式为:yyyy-MM-ddTHH:mmZ。

2021-01-21T17:12:35.232Z
FinishedAtstring

工作流任务节点的结束运行时间。按照ISO8601标准表示,使用UTC+0时间。格式为:yyyy-MM-ddTHH:mmZ。

2021-01-21T17:12:35.232Z
NodeNamestring

工作流任务节点名。

dataSource
Outputsarray

工作流任务节点的输出产物列表。

object

工作流任务节点的输出产物。

Namestring

工作流任务节点的输出产物名称。

model_******
Typestring

输出产物的类型,可能值:

  • Model:模型。
  • DataSet:数据集。
  • Metrics:度量数据。
  • ModelEvaluation:模型评估结果。
DataSet
Metadataobject

输出产物的元数据。

GmtCreateTimestring

输出产物的创建时间。

2021-01-30T12:51:33.028Z
Idstring

输出产物的ID。

artifact-ty1xwv*******s8zf
Producerstring

输出产物的生产者。

id-3d25-************-77856
NodeIdstring

输出产物所属的工作流任务节点的ID。

node-obpzu*******418grb7
PipelineRunIdstring

输出产物所属的工作流任务的ID。

flow-dsjfk******jdskls
Valuestring

输出产物的值。

{\"name\": \"model_flow_*********_node_**********_model\", \"location\": {\"name\": \"model_flow_**********_node_***********_model\", \"endpoint\": \"http://service.odps.aliyun.com/api\", \"project\": \"********\"}}
ExpandedArtifactIndexinteger

输出产物被扩展Artifact的索引号,起始值为0。

0
ExpandableArtifactNamestring

输出产物可扩展Artifact的名称。

inputArtifact

示例

正常返回示例

JSON格式

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

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2022-12-15OpenAPI 返回结构发生变更
变更项变更内容
出参OpenAPI 返回结构发生变更
2022-06-14新增 OpenAPI