Use GetPipelineRun to query pipeline run information - Platform For AI - Alibaba Cloud - Platform For AI

Retrieves information about a pipeline job.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

paiflow:GetPipelineRun

get

*All Resource

*

None

Request syntax

GET /api/v1/pipelineruns/{PipelineRunId} HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
PipelineRunId	string	Yes	The pipeline job ID. You can call ListPipelineRuns to obtain the pipeline job ID.	run-rbvg**********ks92

Request parameters

Parameter	Type	Required	Description	Example
Verbose	boolean	No	Whether to return detailed information. Valid values: false: does not return detailed information. true: returns detailed information, including the Manifest.	false
ManifestType	string	No	The type of manifest to return. Valid values: Raw (default): the original manifest submitted by the user. Frozen: generates a UUID for each pipeline and freezes the pipeline version. Even if you upgrade the pipeline when the three tuples defined on a node remain unchanged, the original UUID is still used. In this case, you can re-run the pipeline based on this manifest. Rendered: injects related information into the pipeline and renders it, including completing runtime environment information and optimizing pipeline configurations. Expanded: provides a complete definition for each pipeline. Runtime: the pipeline to be run. Valid values: Runtime : Runtime Raw : Raw Frozen : Frozen Rendered : Rendered Expanded : Expanded	Raw
TokenId	string	No	The ID of the shared pipeline job.	https://pai.console.alibabacloud.com/?regionId=cn-hangzhou&workspaceId=102****&mode=noSidebar#/paiflow/pipeline-runs/flow-6y7**?Token=eyJ0e****

Response elements

Element	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-j94y**********lf7a
Name	string	The name of the pipeline job.	testName
Status	string	The status of the pipeline job. Valid values: Initialized Running Succeeded Failed Suspended Terminated Unknown Skipped Terminating	Succeeded
Manifest	string	The definition of the pipeline job.	{"ApiVersion":"core/v1","Metadata":{"NodeId":"node-n06d********fc53","Provider":"155******904","Name":"flow-j94y******lf7a","Version":"v1","Identifier":"9fe11111----**ec811861","Namespace":null,"DisplayName":"name","NodeType":"Dag"},"Spec":{}}
Arguments	string	The parameters for the pipeline job.	{"arguments":{"parameters":[{"name":"execution","value":{"endpoint":"http://service.****","odpsProject":"**","spec":{"endpoint":"http://service.**","odpsProject":"***"},"resourceType":"MaxCompute"}}]}}
UserId	string	The ID of the RAM user used to create the pipeline.	155**********904
ParentUserId	string	The ID of the Alibaba Cloud account used to create the pipeline.	155**********904
StartedAt	string	The time when the pipeline job started in UTC, in the ISO 8601 format.	2021-01-30T12:51:33.028Z
FinishedAt	string	The time when the pipeline job ended in UTC, in the ISO 8601 format.	2021-01-30T12:52:33.028Z
NodeId	string	The pipeline ID.	node-n06d**********fc53
Duration	integer	The running duration of the pipeline job. Unit: seconds.	60
WorkspaceId	string	The ID of the workspace to which the pipeline job belongs.	15945
Message	string	The failure message of the pipeline job.	error message
SourceType	string	The type of the pipeline job source. Valid values: UNKNOWN: If you leave this parameter empty, UNKNOWN is used as the default value. SDK: The pipeline job is created by using an SDK. DESIGNER: The pipeline job is created in Machine Learning Designer. M6: The pipeline job is created on other websites.	UNKNOWN
SourceId	string	The ID of the pipeline job source.	abcd*********hxfu
Options	string	The options for the pipeline job in JSON format.	{"mlflow":{"experimentId":"exp-**********"}}
GmtCreateTime	string	The time when the pipeline job was created in UTC, in the ISO 8601 format.	2021-01-30T12:51:33.028Z
GmtModifiedTime	string	The time when the pipeline job was last modified in UTC, in the ISO 8601 format.	2021-01-30T12:51:33.028Z
PipelineId	string	The pipeline ID.	pipeline-j94y**********lf7a
Accessibility	string	The accessibility of the pipeline job. Valid values: PUBLIC PRIVATE	PUBLIC
PipelineRunUri	string	The URL of the pipeline job.	https://pai.console.alibabacloud.com/?regionId=cn-shanghai&workspaceId=24**#/studio/task/detail/flow-dsfbjt4k07lvp1**

Examples

Success response

JSON format

{
  "RequestId": "DA869D1B-035A-43B2-ACC1-C56681BD9FAA\n",
  "PipelineRunId": "flow-j94y**********lf7a\n",
  "Name": "testName",
  "Status": "Succeeded",
  "Manifest": "{\"ApiVersion\":\"core/v1\",\"Metadata\":{\"NodeId\":\"node-n06d**********fc53\",\"Provider\":\"155**********904\",\"Name\":\"flow-j94y**********lf7a\",\"Version\":\"v1\",\"Identifier\":\"9fe11111-****-****-****-****ec811861\",\"Namespace\":null,\"DisplayName\":\"name\",\"NodeType\":\"Dag\"},\"Spec\":{}}",
  "Arguments": "{\"arguments\":{\"parameters\":[{\"name\":\"execution\",\"value\":{\"endpoint\":\"http://service.******\",\"odpsProject\":\"******\",\"spec\":{\"endpoint\":\"http://service.******\",\"odpsProject\":\"*****\"},\"resourceType\":\"MaxCompute\"}}]}}",
  "UserId": "155**********904\n",
  "ParentUserId": "155**********904\n",
  "StartedAt": "2021-01-30T12:51:33.028Z\n",
  "FinishedAt": "2021-01-30T12:52:33.028Z\n",
  "NodeId": "node-n06d**********fc53\n",
  "Duration": 60,
  "WorkspaceId": "15945",
  "Message": "error message\n",
  "SourceType": "UNKNOWN",
  "SourceId": "abcd*********hxfu\n",
  "Options": "{\"mlflow\":{\"experimentId\":\"exp-**********\"}}\n",
  "GmtCreateTime": "2021-01-30T12:51:33.028Z\n",
  "GmtModifiedTime": "2021-01-30T12:51:33.028Z\n",
  "PipelineId": "pipeline-j94y**********lf7a\n",
  "Accessibility": "PUBLIC",
  "PipelineRunUri": "https://pai.console.alibabacloud.com/?regionId=cn-shanghai&workspaceId=24****#/studio/task/detail/flow-dsfbjt4k07lvp1****"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.