全部產品
Search

搜尋本產品

    Platform For AI：GetPipelineRun - 擷取工作流程工作資訊

    文件中心

    Platform For AI：GetPipelineRun - 擷取工作流程工作資訊

    更新時間：Dec 23, 2025

    擷取工作流程工作詳情資訊。

    調試

    您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

    調試

    授權資訊

    下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    paiflow:GetPipelineRun

    get

    *全部資源

    *

    		 無 無

    請求文法

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

    路徑參數

    名稱

    類型

    必填

    描述

    樣本值
    PipelineRunId

    string

    是

    工作流程工作 ID。如何擷取工作流程工作 ID，請參見 ListPipelineRuns 。

    run-rbvg**********ks92

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    Verbose

    boolean

    否

    是否返回詳細資料，取值如下。

    • 關閉開關：不顯示詳細資料。

    • 開啟開關：顯示詳細資料，目前詳細資料包含 Manifest 欄位。

    false

    ManifestType

    string

    否

    具體返回哪種類型的 Manifest 資訊，取值如下。

    • Raw（預設）：使用者提交的原始 Manifest。

    • Frozen：針對每個 Pipeline 產生唯一 Uuid，將其版本固化下來。即使遇到子 Pipeline 定義三元組不變進行升級，依然會使用一開始的版本(Uuid)，不受影響；即可基於該 Manifest 進行重跑。

    • Rendered：將相關資訊進行注入和渲染，包括：補全運行環境資訊並最佳化等。

    • Expanded: 針對每個 Pipeline 補充完整定義。

    • Runtime：待啟動並執行工作流程。

    枚舉值：

    • Runtime :

      Runtime

    • Raw :

      Raw

    • Frozen :

      Frozen

    • Rendered :

      Rendered

    • Expanded :

      Expanded

    Raw
    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。

    DA869D1B-035A-43B2-ACC1-C56681BD9FAA

    PipelineRunId

    string

    工作流程工作 ID。

    flow-j94y**********lf7a

    Name

    string

    工作流程工作名字。

    testName
    Status

    string

    工作流程工作狀態，可能值如下：

    • Initialized

    • Running

    • Succeeded

    • Failed

    • Suspended

    • Terminated

    • Unknown

    • Skipped

    • Terminating

    Succeeded
    Manifest

    string

    工作流程工作的定義。

    {"ApiVersion":"core/v1","Metadata":{"NodeId":"node-n06d**********fc53","Provider":"155**********904","Name":"flow-j94y**********lf7a","Version":"v1","Identifier":"9fe11111-****-****-****-****ec811861","Namespace":null,"DisplayName":"name","NodeType":"Dag"},"Spec":{}}
    Arguments

    string

    工作流程工作的參數。

    {"arguments":{"parameters":[{"name":"execution","value":{"endpoint":"http://service.******","odpsProject":"******","spec":{"endpoint":"http://service.******","odpsProject":"*****"},"resourceType":"MaxCompute"}}]}}
    UserId

    string

    建立使用者識別碼。

    155**********904

    ParentUserId

    string

    建立使用者阿里雲帳號的 ID。

    155**********904

    StartedAt

    string

    工作流程工作的開始 UTC 時間，格式 ISO8601。

    2021-01-30T12:51:33.028Z

    FinishedAt

    string

    工作流程工作的結束 UTC 時間，格式 ISO8601。

    2021-01-30T12:52:33.028Z

    NodeId

    string

    工作流程工作的節點 ID。

    node-n06d**********fc53

    Duration

    integer

    工作流程工作的運行時間長度，單位為秒。

    60
    WorkspaceId

    string

    所屬工作空間 ID。

    15945
    Message

    string

    工作流程工作失敗提示資訊。

    error message

    SourceType

    string

    工作流程工作來源類型，可能值：

    • UNKNOWN（預設）：未指定來源類型時的預設值。

    • SDK：通過 SDK 建立的工作流程工作。

    • DESIGNER：通過 Designer 建立的工作流程工作。

    • M6：通過其他網站建立的工作流程工作。

    UNKNOWN
    SourceId

    string

    工作流程工作的來源 ID。

    abcd*********hxfu

    Options

    string

    工作流程工作選項，格式為 JSON。

    {"mlflow":{"experimentId":"exp-**********"}}

    GmtCreateTime

    string

    建立 UTC 時間，格式 ISO8601。

    2021-01-30T12:51:33.028Z

    GmtModifiedTime

    string

    最近修改 UTC 時間，格式 ISO8601。

    2021-01-30T12:51:33.028Z

    PipelineId

    string

    工作流程 ID。

    pipeline-j94y**********lf7a

    Accessibility

    string

    工作流程工作的可見度，目前支援：

    • PUBLIC

    • PRIVATE

    PUBLIC
    PipelineRunUri

    string

    工作流程工作詳情 URL。

    https://pai.console.alibabacloud.com/?regionId=cn-shanghai&workspaceId=24****#/studio/task/detail/flow-dsfbjt4k07lvp1****

    樣本

    正常返回樣本

    JSON格式

    {
  "RequestId": "DA869D1B-035A-43B2-ACC1-C56681BD9FAA\n",
  "PipelineRunId": "flow-j94y**********lf7a\n",
  "Name": "testName",
  "Status": "Succeeded",
  "Manifest": "{\"ApiVersion\":\"core/v1\",\"Metadata\":{\"NodeId\":\"node-n06d**********fc53\",\"Provider\":\"155**********904\",\"Name\":\"flow-j94y**********lf7a\",\"Version\":\"v1\",\"Identifier\":\"9fe11111-****-****-****-****ec811861\",\"Namespace\":null,\"DisplayName\":\"name\",\"NodeType\":\"Dag\"},\"Spec\":{}}",
  "Arguments": "{\"arguments\":{\"parameters\":[{\"name\":\"execution\",\"value\":{\"endpoint\":\"http://service.******\",\"odpsProject\":\"******\",\"spec\":{\"endpoint\":\"http://service.******\",\"odpsProject\":\"*****\"},\"resourceType\":\"MaxCompute\"}}]}}",
  "UserId": "155**********904\n",
  "ParentUserId": "155**********904\n",
  "StartedAt": "2021-01-30T12:51:33.028Z\n",
  "FinishedAt": "2021-01-30T12:52:33.028Z\n",
  "NodeId": "node-n06d**********fc53\n",
  "Duration": 60,
  "WorkspaceId": "15945",
  "Message": "error message\n",
  "SourceType": "UNKNOWN",
  "SourceId": "abcd*********hxfu\n",
  "Options": "{\"mlflow\":{\"experimentId\":\"exp-**********\"}}\n",
  "GmtCreateTime": "2021-01-30T12:51:33.028Z\n",
  "GmtModifiedTime": "2021-01-30T12:51:33.028Z\n",
  "PipelineId": "pipeline-j94y**********lf7a\n",
  "Accessibility": "PUBLIC",
  "PipelineRunUri": "https://pai.console.alibabacloud.com/?regionId=cn-shanghai&workspaceId=24****#/studio/task/detail/flow-dsfbjt4k07lvp1****"
}

    錯誤碼

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

    變更歷史

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