GetPipeline - 获取工作流 - 人工智能平台 PAI

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

paiflow:GetPipeline

get

*全部资源

*

无

请求语法

GET /api/v1/pipelines/{PipelineId} HTTP/1.1

路径参数

名称	类型	必填	描述	示例值
PipelineId	string	是	工作流 ID。如何获取工作流任务 ID，请参见 ListPipelineRuns 。	pipeline-hynm2bv8wqhp5e****

请求参数

名称

类型

必填

描述

示例值

当前API无需请求参数

返回参数

名称	类型	描述	示例值
	object	返回结构体。
RequestId	string	请求 ID。	63EDFF2F-4D51-46F0-9D65-2F8F393B****
PipelineId	string	工作流 ID。	pipeline-hynm2bv8wqhp5e****
Provider	string	自定义工作流，为用户 ID。官方工作流为 PAI。	132668941337****
Identifier	string	工作流标识。	SqlWrite
Version	string	工作流版本。	v1
Manifest	string	工作流定义。	apiVersion: ****
GmtCreateTime	string	创建 UTC 时间，日期格式 ISO8601。	2021-01-21T17:12:35.232Z
GmtModifiedTime	string	最后修改 UTC 时间，日期格式 ISO8601。	2021-01-21T17:12:35.232Z
Uuid	string	工作流当前版本标识，用户每次更新，会生成该 Uuid。	q8dp9hklueznhg****
WorkspaceId	string	工作空间 ID。	726**

返回参数 Manifest 补充说明

apiVersion: "core/v1"
metadata:
  version: "v1"
  # 工作流的提供方。
  provider: "132668**********"
  identifier: "my***"
spec:
  inputs:
    parameters:
    - name: "inputTableName"
      value: "myDefault"
      # 类型，支持 String， Double， Bool， Int， Map， List。
      type: "String"
      desc: "Table Name"
      # 参数是否必填，默认 false。
      required: false
  outputs:
    artifacts:
    - name: "outputTable"
      metadata:
        # 类型，支持 DataSet，Model，ModelEvaluation，Any，DataStream，Raw（原始数据），本例为 DataSet。
        type:
          DataSet:
            locationType: "MaxComputeTable"
      desc: "Source MaxCompute Table Output Port"
  container:
    image: "registry.***.com/***/***:v*"
    command:
    - "bash"
    - "***.sh"
    volumeMounts:
    - name: "download-volume"
      path: "/***"
  initContainers:
  - image: "registry.***.com/***/***:v*"
    command:
    - "***.sh"
    args:
    - "--***"
    name: "initdownload"
    volumeMounts:
    - name: "download-volume"
      path: "/downloadPath"
  volumes:
  - name: "download-volume"
    emptyDir: {}

示例

正常返回示例

JSON格式

{
  "RequestId": "63EDFF2F-4D51-46F0-9D65-2F8F393B****",
  "PipelineId": "pipeline-hynm2bv8wqhp5e****",
  "Provider": "132668941337****",
  "Identifier": "SqlWrite",
  "Version": "v1",
  "Manifest": "apiVersion: ****",
  "GmtCreateTime": "2021-01-21T17:12:35.232Z",
  "GmtModifiedTime": "2021-01-21T17:12:35.232Z",
  "Uuid": "q8dp9hklueznhg****",
  "WorkspaceId": "726**"
}

错误码

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

变更历史

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