GetPipelineRunNode - 获取工作流任务节点信息 - 人工智能平台 PAI

工作流任务中包含多个节点，通过该接口获取节点的详细信息。

接口说明

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

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

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

paiflow:GetPipelineRunNode

get

*全部资源

*

无

请求语法

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

路径参数

名称	类型	必填	描述	示例值
PipelineRunId	string	是	工作流任务的 ID。如何获取工作流任务 ID，请参见 ListPipelineRuns 。	flow-ebppc********5lwea
NodeId	string	是	工作流任务中一个节点的 ID。如何查看节点 ID，请参见 ListPipelineRuns 。	node-wcs9z********27ps3

请求参数

名称	类型	必填	描述	示例值
Depth	integer	否	查询节点详细信息的深度（层数），当 Depth 为 2 时，将会返回该节点及其下一层的所有子节点的详细信息。	2
Type	string	否	节点类型，取值如下： Logical（默认值）：表示逻辑节点，用户提交节点的都是逻辑节点。 Physical：表示物理节点，对应一个执行特定逻辑的容器的运行，逻辑节点在后台运行时会转换为物理节点。	Logical
TokenId	string	否	被分享的工作流任务的 ID。	https://pai.console.alibabacloud.com/?regionId=cn-hangzhou&workspaceId=102****&mode=noSidebar#/paiflow/pipeline-runs/flow-6y7**?Token=eyJ0e****

返回参数

名称	类型	描述	示例值
	object	返回体结构。
RequestId	string	请求 ID。	0a981ea816**********42244e7ba2
ApiVersion	string	工作流定义的版本。	core/v1
Metadata	object	节点的元信息。
NodeId	string	节点的 ID。	node-wcs9z********27ps3
Provider	string	节点所对应的工作流的提供方，通常情况下指代工作流的上传者（官方提供的工作流 Provider 为 PAI）。	15577********904
Name	string	节点的名称。	flow-ebppc********5lwea
Version	string	节点所对应的工作流的版本。	v1
Identifier	string	节点所对应的工作流的标识名。	composite-pipeline
NodeType	string	节点的类型，可能值： Pod：具体运行的一个节点。 Dag：复合类型节点，本质是一个由子节点组成的 Dag 图。	Dag
RelatedNodeIds	array	Alink 逻辑节点所对应的物理节点 ID 或 Alink 物理节点所对应的逻辑节点 ID。
	string	节点 ID。	node-wcs9z********27ps3
DisplayName	string	节点的展示名称（可能会被修改）。	flow-ebppc********5lwea
Spec	object	节点的定义。
HasPipelines	boolean	该节点是否含有子节点，可能值： true：该节点为复合类型节点，如果需要进一步查询其子节点信息，需要传入更深的 Depth 参数。 false：该节点为实际运行的节点。	true
Dependencies	array	节点与其他节点的依赖关系。
	string	所依赖的其他节点对应工作流的名称。	"single-node-sub1"
Pipelines	array<object>	子节点列表。
	object	子节点的详细信息。	详细结构参见Pipeline相关接口描述。
Inputs	object	节点的输入信息。
Artifacts	array<object>	节点的输入产物列表。
	object	节点的输入产物。	{"Name":"input","Value":"******"}
Parameters	array<object>	节点的输入参数列表。
	object	节点的输入参数。	{"Name":"inputTable","Value":"******"}
Outputs	object	节点的输出信息。
Artifacts	array<object>	节点的输出产物列表。
	object	节点的输出产物。	{"Name":"output","Value":"******"}
Parameters	array<object>	节点的输出参数列表。
	object	节点的输出参数。	{"Name":"outputTable","Value":"******"}
When	string	节点运行的判断条件。如果运行条件返回为真，就执行该节点。如果运行条件返回为假，该节点被跳过，状态为 Skipped。	”{{inputs.parameters.skip}} == false“
WithItems	array	将工作流节点扩展为多个工作流节点。
	string	数据集中的一项，会扩展为一个工作流节点。	abc
WithParam	string	指向一个参数，该参数的值是一个数组，数组的每一项会扩展为一个工作流节点。	"{{pipelines.generate.outputs.result}}"
WithSequence	object	指向一个数字序列，序列中的每一项会扩展为一个工作流节点。
Start	integer	数字序列的起始数字。	1
End	integer	数字序列的结束数字。	10
Format	string	对数字序列的值进行格式化。	"2020-05-%d"
Parallelism	integer	节点并行度上限。	2
StatusInfo	object	节点的执行状态信息。
FinishedAt	string	节点执行的结束时间。	2021-10-15T10:40:54.000Z
StartedAt	string	节点执行的开始时间。	2021-10-15T10:39:58.000Z
Status	string	节点的运行状态，可能值： Succeeded：运行成功。 Running：运行中。 Failed：运行失败。 Skipped：跳过（前序节点失败导致）。 ReadyToSchedule：准备运行（前序节点未完成导致）。 Unknown：未知。	Succeeded
Conditions	array<object>	节点的运行状况列表。
	object	节点的详细运行状况。	{"ArtifactArchived": "true"}
Progress	string	节点的运行进度。	9/9

示例

正常返回示例

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

错误码

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

变更历史

更多信息，参考变更详情。