工作流任務中包含多個節(jié)點,通過該接口獲取節(jié)點的詳細信息。
接口說明
PAIFlow 支持復合形式的工作流,這些工作流在運行時也會體現(xiàn)為復合形式的節(jié)點。想要獲取到這類節(jié)點的詳細信息,可以傳入 Depth 參數(默認值為 2),可以遞歸地獲取到所查詢節(jié)點及其內含有的 Depth 層數的子節(jié)點的詳細信息。
工作流的每次運行會存在一個虛擬的根節(jié)點,這個根節(jié)點可以通過 GetRun 接口返回獲取。調用 GetNode 接口查詢該根節(jié)點,可以獲取到對應運行的所有節(jié)點的詳細信息及其組織結構。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
當前API暫無授權信息透出。
請求語法
GET /api/v1/pipelineruns/{PipelineRunId}/nodes/{NodeId}
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
PipelineRunId | string | 是 | 工作流任務的 ID。如何獲取工作流任務 ID,請參見 ListPipelineRuns 。 | flow-ebppc********5lwea |
NodeId | string | 是 | 工作流任務中一個節(jié)點的 ID。如何查看節(jié)點 ID,請參見 ListPipelineRuns 。 | node-wcs9z********27ps3 |
Depth | integer | 否 | 查詢節(jié)點詳細信息的深度(層數),當 Depth 為 2 時,將會返回該節(jié)點及其下一層的所有子節(jié)點的詳細信息。 | 2 |
Type | string | 否 | 節(jié)點類型,取值如下。
| 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 入參發(fā)生變更 | 查看變更詳情 |
2022-07-06 | OpenAPI 返回結構發(fā)生變更 | 查看變更詳情 |
2022-06-14 | 新增 OpenAPI | 查看變更詳情 |