工作流任务中包含多个节点,通过该接口获取节点的详细信息。
接口说明
PAIFlow 支持复合形式的工作流,这些工作流在运行时也会体现为复合形式的节点。想要获取到这类节点的详细信息,可以传入 Depth 参数(默认值为 2),可以递归地获取到所查询节点及其内含有的 Depth 层数的子节点的详细信息。
工作流的每次运行会存在一个虚拟的根节点,这个根节点可以通过 GetRun 接口返回获取。调用 GetNode 接口查询该根节点,可以获取到对应运行的所有节点的详细信息及其组织结构。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求语法
GET /api/v1/pipelineruns/{PipelineRunId}/nodes/{NodeId}
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
PipelineRunId | string | 是 | 工作流任务的 ID。如何获取工作流任务 ID,请参见 ListPipelineRuns 。 | flow-ebppc********5lwea |
NodeId | string | 是 | 工作流任务中一个节点的 ID。如何查看节点 ID,请参见 ListPipelineRuns 。 | node-wcs9z********27ps3 |
Depth | integer | 否 | 查询节点详细信息的深度(层数),当 Depth 为 2 时,将会返回该节点及其下一层的所有子节点的详细信息。 | 2 |
Type | string | 否 | 节点类型,取值如下。
| Logical |
TokenId | string | 否 | 被分享的工作流任务的 ID。 | https://pai.console.aliyun.com/?regionId=cn-hangzhou&workspaceId=102******&mode=noSidebar#/paiflow/pipeline-runs/flow-6y7******?Token=eyJ0e****** |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "0a981ea816**********42244e7ba2",
"ApiVersion": "core/v1",
"Metadata": {
"NodeId": "node-wcs9z********27ps3",
"Provider": "15577********904",
"Name": "flow-ebppc********5lwea",
"Version": "v1",
"Identifier": "composite-pipeline",
"NodeType": "Dag",
"RelatedNodeIds": [
"node-wcs9z********27ps3"
],
"DisplayName": "flow-ebppc********5lwea"
},
"Spec": {
"HasPipelines": true,
"Dependencies": [
"\"single-node-sub1\""
],
"Pipelines": [
{
"test": "test",
"test2": 1
}
],
"Inputs": {
"Artifacts": [
{
"Name": "input",
"Value": "******"
}
],
"Parameters": [
{
"Name": "inputTable",
"Value": "******"
}
]
},
"Outputs": {
"Artifacts": [
{
"Name": "output",
"Value": "******"
}
],
"Parameters": [
{
"Name": "outputTable",
"Value": "******"
}
]
},
"When": "”{{inputs.parameters.skip}} == false“",
"WithItems": [
"abc"
],
"WithParam": "\"{{pipelines.generate.outputs.result}}\"",
"WithSequence": {
"Start": 1,
"End": 10,
"Format": "\"2020-05-%d\""
},
"Parallelism": 2
},
"StatusInfo": {
"FinishedAt": "2021-10-15T10:40:54.000Z",
"StartedAt": "2021-10-15T10:39:58.000Z",
"Status": "Succeeded",
"Conditions": [
{
"ArtifactArchived": "true"
}
],
"Progress": "9/9"
}
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-07-24 | API 内部配置变更,不影响调用 | 查看变更详情 |
2023-12-21 | OpenAPI 入参发生变更 | 查看变更详情 |
2022-07-06 | OpenAPI 返回结构发生变更 | 查看变更详情 |
2022-06-14 | 新增 OpenAPI | 查看变更详情 |