批量获取工作流任务或节点的状态。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求语法
PUT /api/v1/pipelineruns
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
body | object | 否 | 查询请求。 | |
PipelineRuns | array | 否 | 要查询的工作流任务列表,PipelineRuns 参数与 Nodes 参数两选一,优先 Nodes。 | |
string | 否 | 工作流任务的 ID。如何获取工作流任务 ID,请参见 ListPipelineRuns 。 | flow-hynm2bv8wqhp5esfxq | |
Nodes | array<object> | 否 | 要查询的节点列表,Nodes 参数与 PipelineRuns 参数两选一,优先 Nodes。 | |
object | 否 | 要查询的节点。 | ||
PipelineRunId | string | 否 | 工作流任务的 ID。如何获取工作流任务 ID,请参见 ListPipelineRuns 。 | flow-hynm2bv8wqhp5esfxq |
NodeId | string | 否 | 工作流任务节点的 ID。如何获取节点 ID,请参见 ListPipelineRuns 。 | node-hynm2bv8wqhp5esfx1 |
WorkspaceId | string | 否 | 工作空间的 ID。如何获取工作空间 ID,请参见 ListWorkspaces 。 | 948** |
OutputType | string | 否 | 工作流任务节点产物(Artifact)的类型,取值如下:
| DataSet |
返回参数
示例
正常返回示例
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"
}
]
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-07-24 | API 内部配置变更,不影响调用 | 查看变更详情 |
2022-12-15 | OpenAPI 返回结构发生变更 | 查看变更详情 |
2022-06-14 | 新增 OpenAPI | 查看变更详情 |