文档

GetPipeline - 获取工作流

更新时间:

获取Pipeline信息。

调试

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

授权信息

当前API暂无授权信息透出。

请求语法

GET /api/v1/pipelines/{PipelineId}

请求参数

名称类型必填描述示例值
PipelineIdstring

工作流 ID。如何获取工作流任务 ID,请参见 ListPipelineRuns

pipeline-hynm2bv8wqhp5e****

返回参数

名称类型描述示例值
object

返回结构体。

RequestIdstring

请求 ID。

63EDFF2F-4D51-46F0-9D65-2F8F393B****
PipelineIdstring

工作流 ID。

pipeline-hynm2bv8wqhp5e****
Providerstring

自定义工作流,为用户 ID。官方工作流为 PAI。

132668941337****
Identifierstring

工作流标识。

SqlWrite
Versionstring

工作流版本。

v1
Manifeststring

工作流定义。

apiVersion: ****
GmtCreateTimestring

创建 UTC 时间,日期格式 ISO8601。

2021-01-21T17:12:35.232Z
GmtModifiedTimestring

最后修改 UTC 时间,日期格式 ISO8601。

2021-01-21T17:12:35.232Z
Uuidstring

工作流当前版本标识,用户每次更新,会生成该 Uuid。

q8dp9hklueznhg****
WorkspaceIdstring

工作空间 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**"
}

错误码

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

变更历史

变更时间变更内容概要操作
2024-07-24API 内部配置变更,不影响调用查看变更详情