GetPipelineRunNode - Platform For AI - Alibaba Cloud Documentation Center

Queries information about a node. A pipeline job contains a variety of nodes.

Operation description

PAIFlow supports composite pipelines, which are reflected as composite nodes during running. To obtain information about such nodes, you can configure the Depth parameter (default value: 2). You can configure the Depth parameter to recursively obtain information about the queried node and its child nodes.

A virtual root node exists each time a pipeline runs. You can call GetRun to obtain the root node. You can call GetNode to query the root node. The returned result also includes information about all nodes that run and their hierarchies.

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

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
PipelineRunId	string	Yes	The ID of the pipeline job. You can call ListPipelineRuns to obtain the ID of the pipeline job.	flow-ebppc********5lwea
NodeId	string	Yes	The ID of a node in the pipeline job. You can call ListPipelineRuns to obtain the node ID.	node-wcs9z********27ps3
Depth	integer	No	The depth at which information about the node is queried. If you set Depth to 2, the information about the node and all its child nodes at the next layer is returned.	2
Type	string	No	The node type. Valid values: Logical (default): the logical node. The nodes submitted by users are logical nodes. Physical: the physical node on which a container is deployed for executing specific logic. A logical node is converted to a physical node when the logical node runs in the background.	Logical
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 parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	0a981ea816**********42244e7ba2
ApiVersion	string	The version defined in the pipeline.	core/v1
Metadata	object	The node metadata.
NodeId	string	The node ID.	node-wcs9z********27ps3
Provider	string	The provider of the pipeline for the node. In most cases, this parameter indicates the uploader of the pipeline. If the pipeline is officially provided, the parameter value is PAI.	15577********904
Name	string	The node name.	flow-ebppc********5lwea
Version	string	The version of the pipeline for the node.	v1
Identifier	string	The identifier of the pipeline for the node.	composite-pipeline
NodeType	string	The node type. Valid values: Pod: the specific node that runs. Dag: the composite node, which is essentially a directed acyclic graph (DAG) consisting of child nodes.	Dag
RelatedNodeIds	array	The ID of the physical node corresponding to the Alink logical node or the ID of the logical node corresponding to the Alink physical node.
RelatedNodeIds	string	The node ID.	node-wcs9z********27ps3
DisplayName	string	The display name of the node, which can be modified.	flow-ebppc********5lwea
Spec	object	The node specifications.
HasPipelines	boolean	Indicates whether the node contains child nodes. Valid values: true: The node is a composite node. To query information about its child nodes, you must specify the Depth parameter. false: The node is the one that actually runs.	true
Dependencies	array	The dependencies between the node and other nodes.
Dependencies	string	The name of the pipeline for other nodes that the node depends on.	"single-node-sub1"
Pipelines	array<object>	The child nodes.
Pipelines	object	The child node.
Inputs	object	The input information about of the node.
Artifacts	array<object>	The node inputs.
Artifacts	object	The node input.	{"Name":"input","Value":"******"}
Parameters	array<object>	The input parameters of the node.
Parameters	object	The input parameter of the node.	{"Name":"inputTable","Value":"******"}
Outputs	object	The output information about of the node.
Artifacts	array<object>	The node outputs.
Artifacts	object	The node output.	{"Name":"output","Value":"******"}
Parameters	array<object>	The output parameters of the node.
Parameters	object	The output parameter of the node.	{"Name":"outputTable","Value":"******"}
When	string	The condition on which the node runs. If true is returned, the node is executed. If false is returned, the node is skipped and the node status becomes Skipped.	”{{inputs.parameters.skip}} == false“
WithItems	array	Expands one pipeline node into multiple pipeline nodes.
WithItems	string	Expands an item in the dataset into a pipeline node.	abc
WithParam	string	Expands each item in an array that is the value type of a parameter into a pipeline node.	"{{pipelines.generate.outputs.result}}"
WithSequence	object	Expands each item of a numerical sequence into a pipeline node.
Start	integer	The start number of the numerical sequence.	1
End	integer	The end number of the numerical sequence.	10
Format	string	Formats the value of the numerical sequence.	"2020-05-%d"
Parallelism	integer	The maximum parallelism of the nodes.	2
StatusInfo	object	The execution status of the node.
FinishedAt	string	The time when the node finished execution.	2021-10-15T10:40:54.000Z
StartedAt	string	The time when the node started to execute.	2021-10-15T10:39:58.000Z
Status	string	The running status of the node. Valid values: Succeeded Running Failed Skipped: The node status becomes Skipped when its upstream node fails to be executed. ReadyToSchedule: The node status becomes ReadyToSchedule if its upstream node is being executed. Unknown	Succeeded
Conditions	array<object>	The running conditions of the node.
Conditions	object	The running condition of the node.	{"ArtifactArchived": "true"}
Progress	string	The running progress of the node.	9/9

Examples

Sample success responses

JSONformat

{
  "RequestId": "0a981ea816**********42244e7ba2",
  "ApiVersion": "core/v1",
  "Metadata": {
    "NodeId": "node-wcs9z********27ps3",
    "Provider": "15577********904",
    "Name": "flow-ebppc********5lwea",
    "Version": "v1",
    "Identifier": "composite-pipeline",
    "NodeType": "Dag",
    "RelatedNodeIds": [
      "node-wcs9z********27ps3"
    ],
    "DisplayName": "flow-ebppc********5lwea"
  },
  "Spec": {
    "HasPipelines": true,
    "Dependencies": [
      "single-node-sub1"
    ],
    "Pipelines": [
      {
        "test": "test",
        "test2": 1
      }
    ],
    "Inputs": {
      "Artifacts": [
        {
          "Name": "input",
          "Value": "******"
        }
      ],
      "Parameters": [
        {
          "Name": "inputTable",
          "Value": "******"
        }
      ]
    },
    "Outputs": {
      "Artifacts": [
        {
          "Name": "output",
          "Value": "******"
        }
      ],
      "Parameters": [
        {
          "Name": "outputTable",
          "Value": "******"
        }
      ]
    },
    "When": "”{{inputs.parameters.skip}} == false“",
    "WithItems": [
      "abc"
    ],
    "WithParam": "{{pipelines.generate.outputs.result}}",
    "WithSequence": {
      "Start": 1,
      "End": 10,
      "Format": "2020-05-%d"
    },
    "Parallelism": 2
  },
  "StatusInfo": {
    "FinishedAt": "2021-10-15T10:40:54.000Z",
    "StartedAt": "2021-10-15T10:39:58.000Z",
    "Status": "Succeeded",
    "Conditions": [
      {
        "ArtifactArchived": true
      }
    ],
    "Progress": "9/9"
  }
}

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
2023-12-21	The request parameters of the API has changed	View Change Details
2022-07-06	The response structure of the API has changed	View Change Details
2022-06-14	Add Operation	View Change Details