Query pipeline node running status with ListPipelineRunNodeStatus - Platform For AI

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:ListPipelineRunNodeStatus

list

*All Resource

*

None

Request syntax

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

Path 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****

Request parameters

Parameter	Type	Required	Description	Example
Depth	integer	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 elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	473469C7-**--**-A3DC0DE3C83E
Status	array<object>	The statuses of the pipeline node.
	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

Success response

JSON format

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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.