ListPipelineRunNodeStatus - Platform For AI - Alibaba Cloud Documentation Center

Queries the running status of a pipeline node.

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:ListPipelineRunNodeStatus	list	All Resources ``	none	none

Request syntax

GET /api/v1/pipelineruns/{PipelineRunId}/nodes/{NodeId}/status 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-rbvg5wzljzjhc9****
NodeId	string	Yes	The ID of the pipeline node. You can call ListPipelineRuns to obtain the node ID.	node-kdkfkfds****
Depth	long	No	The depth at which information about the node is queried. If you set Depth to N, the information about the node and all its child nodes at the N-1 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.	473469C7-**--**-A3DC0DE3C83E
Status	array<object>	The statuses of the pipeline node.
Status	object
NodeId	string	The ID of the pipeline node.	node-1jlzg7ncv0j6i3****
NodeName	string	The name of the pipeline node.	sql
Status	string	The running status of the node.	Succeeded
StartedAt	string	The time when the node started to run, in UTC. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format.	2021-01-21T17:12:35.232Z
FinishedAt	string	The time when the node finished running, in UTC. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format.	2021-01-21T17:12:40.232Z
RuntimeInfo	string	The runtime information of the node, in the escaped MAP format. You can customize the output of multiple KV pairs. If the same key value is used, the last output value is used. If the returned information is empty, {} is returned.	{\"DLC_INSTANCE_IDS\": \"i-12224afdfsaf,i-22224afdfsaf,i-13224afdfsaf\"}

Examples

Sample success responses

JSONformat

{
  "RequestId": "473469C7-****-****-****-A3DC0DE3C83E\n",
  "Status": [
    {
      "NodeId": "node-1jlzg7ncv0j6i3****",
      "NodeName": "sql",
      "Status": "Succeeded",
      "StartedAt": "2021-01-21T17:12:35.232Z",
      "FinishedAt": "2021-01-21T17:12:40.232Z",
      "RuntimeInfo": "{\\\"DLC_INSTANCE_IDS\\\": \\\"i-12224afdfsaf,i-22224afdfsaf,i-13224afdfsaf\\\"}\n"
    }
  ]
}

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-06-14	Add Operation	View Change Details