全部产品
Search

搜索本产品

    人工智能平台 PAI：GetPipelineRun - 获取工作流任务信息

    文档中心

    人工智能平台 PAI：GetPipelineRun - 获取工作流任务信息

    更新时间：Aug 28, 2026

    获取工作流任务详情信息。

    调试

    您可以在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

    创建用户 ID。

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

    错误码

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

    变更历史

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