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

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。