CreatePipelineRun - Platform For AI - Alibaba Cloud Documentation Center

Creates a pipeline job.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
paiflow:CreatePipelineRun	create	All Resources ``	none	none

Request syntax

POST /api/v1/pipelineruns HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
body	object	No	The pipeline job.
PipelineId	string	No	The pipeline ID. You must configure PipelineId or PipelineManifest.	flow-rer7y***
Name	string	No	The name of the pipeline job. If you leave this parameter empty, the system automatically generates a name.	testName
PipelineManifest	string	No	The pipeline definition. For more information, see the sample pipeline definition. You must configure PipelineId or PipelineManifest.	apiVersion: "core/v1"*********
Arguments	string	No	The parameters.	arguments: parameters: - name: "execution_maxcompute" value: endpoint: "http://service*" odpsProject: "pai*"
NoConfirmRequired	boolean	No	Specifies whether to start the pipeline job. Valid values: true (default): starts the pipeline job. false: creates the pipeline job and does not start it.	true
WorkspaceId	string	Yes	The workspace ID.	84***
SourceType	string	No	The type of the pipeline job source. Valid values: UNKNOWN (default) SDK DESIGNER M6	UNKNOWN
SourceId	string	No	The source ID.	experiment-ybpy***
Options	string	No	The options used to create the pipeline job, which are in the JSON format.	{"mlflow":{"experimentId":"exp-1jdk***"}}
Accessibility	string	No	The pipeline accessibility. PUBLIC (default) PRIVATE	PUBLIC

Sample pipeline definition: The pipeline consists of a read table node data_source and a data type conversion node 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: "Read-Table-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: "Data Type Conversion-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"

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	DA869D1B-035A-43B2-ACC1-C56681BD9FAA
PipelineRunId	string	The ID of the pipeline job.	flow-rbvg***

Examples

Sample success responses

JSONformat

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

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-07-24	The internal configuration of the API is changed, but the call is not affected	View Change Details
2022-06-16	The internal configuration of the API is changed, but the call is not affected	View Change Details
2022-06-14	Add Operation	View Change Details