GetPipeline - Platform For AI - Alibaba Cloud Documentation Center

Queries the information about a pipeline.

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:GetPipeline	get	All Resources ``	none	none

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
PipelineId	string	Yes	The pipeline ID. You can call ListPipelineRuns to obtain the ID of the pipeline job.	pipeline-hynm2bv8wqhp5e****

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	63EDFF2F-4D51-46F0-9D65-2F8F393B****
PipelineId	string	The pipeline ID.	pipeline-hynm2bv8wqhp5e****
Provider	string	The value is the user ID for custom pipelines. The value is PAI for pipelines provided by Platform for AI (PAI).	132668941337****
Identifier	string	The pipeline identifier.	SqlWrite
Version	string	The pipeline version.	v1
Manifest	string	The pipeline definition.	apiVersion: ****
GmtCreateTime	string	The time when the pipeline was created, in UTC. The time follows the ISO 8601 standard.	2021-01-21T17:12:35.232Z
GmtModifiedTime	string	The time when the pipeline was modified, in UTC. The time follows the ISO 8601 standard.	2021-01-21T17:12:35.232Z
Uuid	string	The UUID of the pipeline. A UUID is generated each time the user modifies the pipeline.	q8dp9hklueznhg****
WorkspaceId	string	The workspace ID.	726**

Additional description of the Manifest parameter

apiVersion: "core/v1"
metadata:
  version: "v1"
  # The provider of the pipeline.
  provider: "132668**********"
  identifier: "my***"
spec:
  inputs:
    parameters:
    - name: "inputTableName"
      value: "myDefault"
      # The data type. The value can be string, double, bool, integer, map, and list.
      type: "String"
      desc: "Table Name"
      # Specifies whether the parameter is required. Default value: false.
      required: false
  outputs:
    artifacts:
    - name: "outputTable"
      metadata:
        # The metadata type. The value can be DataSet, Model, ModelEvaluation, Any, DataStream, and Raw. In this example, DataSet is used.
        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: {}

Examples

Sample success responses

JSONformat

{
  "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**"
}

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