批量获取工作流任务或节点的状态。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求语法
PUT /api/v1/pipelineruns HTTP/1.1
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| 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 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
返回结构体。 |
||
| RequestId |
string |
请求 ID。 |
473469C7-****-****-****-A3DC0DE3C83E |
| PipelineRuns |
array<object> |
工作流任务列表。 |
|
|
object |
工作流任务。 |
||
| PipelineRunId |
string |
工作流任务 ID。 |
flow-hynm2bv8wqhp5esfxq |
| Status |
string |
工作流任务状态。 |
Running |
| Name |
string |
工作流任务名字。 |
myName |
| UserId |
string |
工作流所属用户 ID。 |
1557702098194904 |
| ParentUserId |
string |
工作流所属主账户 ID。 |
1557702098194904 |
| NodeId |
string |
节点 ID。 |
node-98odqfpcjzwdf3caq3 |
| SourceId |
string |
工作流任务来源 ID。 |
lmi7d24h3kr0xczjlu |
| IsDeleted |
boolean |
是否被删除,可能值:
|
false |
| Nodes |
array<object> |
工作流任务节点列表。 |
|
|
object |
工作流任务节点。 |
||
| PipelineRunId |
string |
工作流任务 ID。 |
flow-hynm2bv8wqhp5esfxq |
| NodeId |
string |
工作流任务节点 ID。 |
node-hynm2bv8wqhp5esfx1 |
| Status |
string |
工作流任务节点状态。 |
Running |
| InputArtifactArchived |
boolean |
输入 Artifact 是否已保存:
|
true |
| OutputArtifactArchived |
boolean |
输出 Artifact 是否已保存:
|
true |
| StartedAt |
string |
工作流任务节点的开始运行时间。按照 ISO8601 标准表示,使用 UTC+0 时间。格式为:yyyy-MM-ddTHH:mmZ。 |
2021-01-21T17:12:35.232Z |
| FinishedAt |
string |
工作流任务节点的结束运行时间。按照 ISO8601 标准表示,使用 UTC+0 时间。格式为:yyyy-MM-ddTHH:mmZ。 |
2021-01-21T17:12:35.232Z |
| NodeName |
string |
工作流任务节点名。 |
dataSource |
| Outputs |
array<object> |
工作流任务节点的输出产物列表。 |
|
|
array<object> |
工作流任务节点的输出产物。 |
||
| Name |
string |
工作流任务节点的输出产物名称。 |
model_****** |
| Type |
string |
输出产物的类型,可能值:
|
DataSet |
| Metadata |
object |
输出产物的元数据。 |
|
| GmtCreateTime |
string |
输出产物的创建时间。 |
2021-01-30T12:51:33.028Z |
| Id |
string |
输出产物的 ID。 |
artifact-ty1xwv*******s8zf |
| Producer |
string |
输出产物的生产者。 |
id-3d25-************-77856 |
| NodeId |
string |
输出产物所属的工作流任务节点的 ID。 |
node-obpzu*******418grb7 |
| PipelineRunId |
string |
输出产物所属的工作流任务的 ID。 |
flow-dsjfk******jdskls |
| Value |
string |
输出产物的值。 |
{\"name\": \"model_flow_*********_node_**********_model\", \"location\": {\"name\": \"model_flow_**********_node_***********_model\", \"endpoint\": \"http://service.odps.aliyun.com/api\", \"project\": \"********\"}} |
| ExpandedArtifactIndex |
integer |
输出产物被扩展 Artifact 的索引号,起始值为 0。 |
0 |
| ExpandableArtifactName |
string |
输出产物可扩展 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"
}
]
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。