GetTaskInstanceRelation - Query task flow instance nodes - Data Management

Queries task node information for a task flow instance.

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

dms:GetTaskInstanceRelation

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
DagId	integer	Yes	The ID of the task flow. You can call the ListTaskFlow or ListLhTaskFlowAndScenario operation to query the task flow ID.	7***
DagInstanceId	integer	Yes	The ID of the task flow execution record. You can call the ListTaskFlowInstance operation to query the execution record ID.	47****
Tid	integer	No	The ID of the tenant. You can call the GetUserActiveTenant or ListUserTenants operation to query the tenant ID.	3***

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	028BF827-3801-5869-8548-F4A039256304
ErrorCode	string	The error code returned if the request failed.	UnknownError
ErrorMessage	string	The error message returned if the request failed.	UnknownError
Success	boolean	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true
NodeList	object
Node	array<object>	The task nodes in the task flow execution record.
	object
Id	integer	The ID of the task flow execution record.	14059
NodeId	integer	The ID of the node.	14059
NodeName	string	The name of the node.	Spark SQL-1
NodeType	integer	The node type. For valid values, see NodeType parameter.	SPARK_SQL
BusinessTime	string	The business time of the node.	2021-11-09 14:37:26
Status	integer	The node status. Valid values: 0: Waiting to be scheduled. 1: Running. 2: Suspended. 3: Failed to run. 4: Run. 5: Completed.	4
Message	string	The description of the task.	test
ExecuteTime	integer	The node execution duration, in milliseconds.	170655
EndTime	string	The time when the task flow execution completed. Format: yyyy-MM-DD HH:mm:ss.	2021-11-11 14:38:57

Examples

Success response

JSON format

{
  "RequestId": "028BF827-3801-5869-8548-F4A039256304",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true,
  "NodeList": {
    "Node": [
      {
        "Id": 14059,
        "NodeId": 14059,
        "NodeName": "Spark SQL-1",
        "NodeType": 0,
        "BusinessTime": "2021-11-09 14:37:26",
        "Status": 4,
        "Message": "test",
        "ExecuteTime": 170655,
        "EndTime": "2021-11-11 14:38:57"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.