GetPipelineRunNode
工作流任务中包含多个节点,通过该接口获取节点的详细信息
服务地址:
华东1(杭州)
输入参数
只看必填
PipelineRunId工作流任务的ID
NodeId工作流任务中一个节点的ID
Depth查询节点详细信息的深度(层数)
Type节点类型
TokenId被分享的工作流任务的ID
插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

PAIFlow 支持复合形式的工作流,这些工作流在运行时也会体现为复合形式的节点。想要获取到这类节点的详细信息,可以传入 Depth 参数(默认值为 2),可以递归地获取到所查询节点及其内含有的 Depth 层数的子节点的详细信息。

工作流的每次运行会存在一个虚拟的根节点,这个根节点可以通过 GetRun 接口返回获取。调用 GetNode 接口查询该根节点,可以获取到对应运行的所有节点的详细信息及其组织结构。

请求语法

GET /api/v1/pipelineruns/{PipelineRunId}/nodes/{NodeId} HTTP/1.1

路径参数

字段名称字段详情
PipelineRunIdstring

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

示例值:flow-ebppc********5lwea参考取值来源:
    ListPipelineRuns
    CreatePipelineRun
NodeIdstring

工作流任务中一个节点的 ID。如何查看节点 ID,请参见 ListPipelineRuns

示例值:node-wcs9z********27ps3

请求参数

字段名称字段详情
Depthinteger<int32>

查询节点详细信息的深度(层数),当 Depth 为 2 时,将会返回该节点及其下一层的所有子节点的详细信息。

示例值:2
Typestring

节点类型,取值如下:展开详情

示例值:Logical
TokenIdstring

被分享的工作流任务的 ID。

示例值:https://pai.console.aliyun.com/?regionId=cn-hangzhou&workspaceId=102******&mode=noSidebar#/paiflow/pipeline-runs/flow-6y7******?Token=eyJ0e******

返回参数

字段名称字段详情
RequestIdstring

请求 ID。

示例值:0a981ea816**********42244e7ba2
ApiVersionstring

工作流定义的版本。

示例值:core/v1
Metadataobject

节点的元信息。

Specobject

节点的定义。

StatusInfoobject

节点的执行状态信息。

变更历史
变更时间变更内容概要操作
2023-12-21
新增请求参数TokenId
2022-07-06
变更返回参数
2022-06-14
新增OpenAPI,获取工作流任务节点信息