調用CreatePipelineRun API建立工作流程工作-人工智慧平台 PAI-阿里雲

建立工作流程工作。

調試

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

調試

授權資訊

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

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

paiflow:CreatePipelineRun

create

*全部資源

*

無

請求文法

POST /api/v1/pipelineruns HTTP/1.1

請求參數

名稱	類型	必填	描述	樣本值
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***"
}

錯誤碼

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

變更歷史

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