调用CreatePipelineRun创建工作流任务_人工智能平台 PAI(PAI)-阿里云帮助中心

创建工作流任务。

调试

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

授权信息

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

请求语法

POST /api/v1/pipelineruns

请求参数

名称	类型	必填	描述	示例值
body	object	否	工作流任务。
PipelineId	string	否	工作流的 ID。 PipelineId 和 PipelineManifest 二选一。	flow-rer7y***
Name	string	否	工作流任务名字。若为空，则自动生成名字。	testName
PipelineManifest	string	否	工作流定义，具体样例见下方请求参数补充说明。 PipelineId 和 PipelineManifest 二选一。	apiVersion: "core/v1"\nmetadata:\n provider: "1557702098******"\n version: "v1"\n identifier: "my_pipeline"\n name: "source-transform"\nspec:\n inputs:\n parameters:\n - name: "execution_maxcompute"\n type: "Map"\n pipelines:\n - apiVersion: "core/v1"\n metadata:\n provider: "pai"\n version: "v1"\n identifier: "data_source"\n name: "data_source"\n displayName: "读数据表-1"\n spec:\n arguments:\n parameters:\n - name: "inputTableName"\n value: "pai_online_project.wumai_data"\n - name: "partition"\n value: "20220101"\n - name: "execution"\n from: "{{inputs.parameters.execution_maxcompute}}"\n - apiVersion: "core/v1"\n metadata:\n provider: "pai"\n version: "v1"\n identifier: "type_transform"\n name: "type_transform"\n displayName: "类型转换-1"\n spec:\n arguments:\n artifacts:\n - name: "inputTable"\n from: "{{pipelines.data_source.outputs.artifacts.outputTable}}"\n parameters:\n - name: "cols_to_double"\n value: "time,hour,pm2,pm10,so2,co,no2"\n - name: "execution"\n from: "{{inputs.parameters.execution_maxcompute}}"\n dependencies:\n - "data_source"
Arguments	string	否	参数。	arguments: parameters: - name: "execution_maxcompute" value: endpoint: "http://service*" odpsProject: "pai*"
NoConfirmRequired	boolean	否	是否直接启动 pipelineRun，取值如下： true 代表直接启动（默认）。 false 代表只创建 run，但先不启动。	true
WorkspaceId	string	是	工作空间 ID。	84***
SourceType	string	否	工作流任务来源类型，支持如下值： UNKNOWN（默认） SDK DESIGNER M6	UNKNOWN
SourceId	string	否	来源 ID。	experiment-ybpy***
Options	string	否	创建工作流任务选项，格式为 JSON。	{"mlflow":{"experimentId":"exp-1jdk***"}}
Accessibility	string	否	工作空间可见性： PUBLIC（默认） PRIVATE	PUBLIC

工作流定义样例：该工作流由读数据表（data_source），类型转换（type_transform）组成。

apiVersion: "core/v1"
metadata:
  provider: "1557702098******"
  version: "v1"
  identifier: "my_pipeline"
  name: "source-transform"
spec:
  inputs:
    parameters:
    - name: "execution_maxcompute"
      type: "Map"
  pipelines:
  - apiVersion: "core/v1"
    metadata:
      provider: "pai"
      version: "v1"
      identifier: "data_source"
      name: "data_source"
      displayName: "读数据表-1"
    spec:
      arguments:
        parameters:
        - name: "inputTableName"
          value: "pai_online_project.wumai_data"
        - name: "partition"
          value: "20220101"
        - name: "execution"
          from: "{{inputs.parameters.execution_maxcompute}}"
  - apiVersion: "core/v1"
    metadata:
      provider: "pai"
      version: "v1"
      identifier: "type_transform"
      name: "type_transform"
      displayName: "类型转换-1"
    spec:
      arguments:
        artifacts:
        - name: "inputTable"
          from: "{{pipelines.data_source.outputs.artifacts.outputTable}}"
        parameters:
        - name: "cols_to_double"
          value: "time,hour,pm2,pm10,so2,co,no2"
        - name: "execution"
          from: "{{inputs.parameters.execution_maxcompute}}"
      dependencies:
      - "data_source"

返回参数

名称	类型	描述	示例值
	object	返回结构体。
RequestId	string	请求 ID。	DA869D1B-035A-43B2-ACC1-C56681BD9FAA
PipelineRunId	string	工作流任务 ID。	flow-rbvg***

示例

正常返回示例

JSON格式

{
  "RequestId": "DA869D1B-035A-43B2-ACC1-C56681BD9FAA",
  "PipelineRunId": "flow-rbvg***"
}

错误码

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

变更历史

变更时间	变更内容概要	操作
2024-07-24	API 内部配置变更，不影响调用	查看变更详情
2022-06-16	API 内部配置变更，不影响调用	查看变更详情
2022-06-14	新增 OpenAPI	查看变更详情