调用ListPipelineRunNodeStatus获取工作流任务节点状态_人工智能平台 PAI(PAI)-阿里云帮助中心

获取工作流任务节点运行状态。

调试

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

授权信息

当前API暂无授权信息透出。

请求语法

GET /api/v1/pipelineruns/{PipelineRunId}/nodes/{NodeId}/status

请求参数

名称	类型	必填	描述	示例值
PipelineRunId	string	是	工作流任务 ID。如何获取工作流任务 ID，请参见 ListPipelineRuns 。	flow-rbvg5wzljzjhc9****
NodeId	string	是	工作流任务的节点 ID。如何获取节点 ID，请参见 ListPipelineRuns 。	node-kdkfkfds****
Depth	long	否	查询节点深度，当深度为 N 时，返回指定节点的 N-1 层子节点运行状态。	2
Type	string	否	节点类型，取值如下： Logical（默认值）：表示逻辑节点，用户提交节点的都是逻辑节点。 Physical：表示物理节点，对应一个执行特定逻辑的容器的运行，逻辑节点在后台运行时会转换为物理节点。	Logical
TokenId	string	否	被分享的工作流任务的 ID。	https://pai.console.aliyun.com/?regionId=cn-hangzhou&workspaceId=102****&mode=noSidebar#/paiflow/pipeline-runs/flow-6y7**?Token=eyJ0e****

返回参数

名称	类型	描述	示例值
	object	返回结构体。
RequestId	string	请求 ID。	473469C7-**--**-A3DC0DE3C83E
Status	array<object>	工作流任务节点状态列表。
	object
NodeId	string	工作流任务的节点 ID。	node-1jlzg7ncv0j6i3****
NodeName	string	工作流任务的节点名字。	sql
Status	string	节点运行状态。	Succeeded
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:40.232Z
RuntimeInfo	string	节点运行时信息，格式为转义后的 Map，用户可以自定义输出多个 KV 对，相同的 Key 值会取最后输出的 Value。当信息为空时，返回“{}”。	{\"DLC_INSTANCE_IDS\": \"i-12224afdfsaf,i-22224afdfsaf,i-13224afdfsaf\"}

示例

正常返回示例

JSON格式

{
  "RequestId": "473469C7-****-****-****-A3DC0DE3C83E\n",
  "Status": [
    {
      "NodeId": "node-1jlzg7ncv0j6i3****",
      "NodeName": "sql",
      "Status": "Succeeded",
      "StartedAt": "2021-01-21T17:12:35.232Z",
      "FinishedAt": "2021-01-21T17:12:40.232Z",
      "RuntimeInfo": "{\\\"DLC_INSTANCE_IDS\\\": \\\"i-12224afdfsaf,i-22224afdfsaf,i-13224afdfsaf\\\"}\n"
    }
  ]
}

错误码

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

变更历史

变更时间	变更内容概要	操作
2024-07-24	API 内部配置变更，不影响调用	查看变更详情
2023-12-21	OpenAPI 入参发生变更	查看变更详情
2022-06-14	新增 OpenAPI	查看变更详情